are timeouts implemented at all?

[bago]

imap2_timeout behave differently wether imap php module is installed or not.

If imap module is installed it sets the timeouts throut "imap_timeout" but then if you try to open an imap connection using OAUTH the timeouts will not be used at all.

if imap module is not installed it sets the timeouts in a Timeout class, that sounds like is not used in the connection code.

[francescobianco]

Hi @bago could you write down here a list of case (real case) where you use the timeout, I need it to build up a real case tests
I want release timeout behavior based on a real programmer cases.

I plan to built it on version for PHP 8.1

Please report here your business needs!
Bye

[bago]

Sometimes the connection hangs while connecting, other times while reading messages. With no timeouts you could find the script hang for days.

In order to test it I'd run a simple socket listener that accept the connection and then stuck forever, then try to connect at it with the library.

I don't want my script to stay appended there for hours: I want to wait at most 60 seconds and then move away from that broken server.

The same may happens after every command: I request a message body, but if it stuck more than 60 seconds I prefer to stop working with that server and move away.

The same with imap_close: sometimes the close operation fails and if you don't have a timeout the script would wait forever.

So the business case is that I want to check a mailbox and retrieve messages but I want to be sure I complete this task in 2 minutes and then I want to move to the next server: I prefer to skip a misbehaving/slow server than slow down the whole process. Timeouts can happen in many places (when you try to open the TCP connection, when you try to write something there, when you try to read an answer and when you try to clean close the connection): IMAP_OPENTIMEOUT, IMAP_READTIMEOUT, IMAP_WRITETIMEOUT, IMAP_CLOSETIMEOUT
https://www.php.net/manual/en/function.imap-timeout.php

I see in "Connection.php" you have a "'timeout' => -1," as preferences passed to Roundcube imap client: maybe passing the Timeout::get() value there would be a first step.

Unfortunately roundcube imapclient doesn't provider granular timeouts, so a compromise will be needed in the "imap_timeout" class.

When imap_client uses streams, you can specify the read/write timeout (as a single timeout) using stream_set_timeout, but even implementing this you can't deal with the 4 different timeouts from the original imap_timeout "interface".

[bago]

PS: even if imap_timeout directive is currently ignored, one can set the ini property "default_socket_timeout" to define a timeout for the roundcube imap_client.

[francescobianco]

Great job @bago ! This is what I'm looking for extremely thanks for your work