imap_timeout
PHP function
Edit on GitHub ✎
(PHP 4 >= 4.3.3, PHP 5, PHP 7, PHP 8)
Set or fetch imap timeout
Description
imap_timeout(int $timeout_type, int $timeout = -1): int|bool
Sets or fetches the imap timeout.
Parameters
timeout_typeOne of the following:
IMAP_OPENTIMEOUT,IMAP_READTIMEOUT,IMAP_WRITETIMEOUT, orIMAP_CLOSETIMEOUT.timeoutThe timeout, in seconds.
Return Values
If the timeout parameter is set, this function returns true on success and false on failure.
If timeout is not provided or evaluates to -1, the current timeout value of timeout_type is returned as an integer.
Examples
imap_timeout() example
php
<?php
echo "The current read timeout is " . imap_timeout(IMAP_READTIMEOUT) . "\n";
?>