imap_timeout
(PHP 4 >= 4.3.3, PHP 5, PHP 7, PHP 8)
imap_timeout — Set or fetch imap timeout
Description
$timeout_type
, int $timeout
= -1): int|boolSets or fetches the imap timeout.
Parameters
-
timeout_type
-
One of the following:
IMAP_OPENTIMEOUT
,IMAP_READTIMEOUT
,IMAP_WRITETIMEOUT
, orIMAP_CLOSETIMEOUT
. -
timeout
-
The 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
Example #1 imap_timeout() example
<?php
echo "The current read timeout is " . imap_timeout(IMAP_READTIMEOUT) . "\n";
?>