imap_timeout

FunctionRemoved in PHP 8.4

Set or fetch imap timeout.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
Removed
PHP 8.5
PHP 8.6

imap_timeout Function synopsis

imap_timeout(int $timeout_type, int $timeout = -1): int|bool

Parameters

$timeout_type

Typeint

One of the following: IMAP_OPENTIMEOUT, IMAP_READTIMEOUT, IMAP_WRITETIMEOUT, or IMAP_CLOSETIMEOUT.

$timeout

OptionalTypeintDefault value-1

The timeout, in seconds.

Return value

Typeint|bool

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.

Changes to the imap_timeout Function

PHP 8.4

  • Function removed

PHP 8.0

  • Return type added: int|bool
  • Parameter type added for parameter #1 ($timeout_type): int
  • Parameter type added for parameter #2 ($timeout): int
  • Parameter default value added for position #2 ($timeout): -1
- imap_timeout($timeout_type, $timeout)
+ imap_timeout(int $timeout_type, int $timeout = -1): int|bool

imap_timeout Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release No
PHP 8.5Supported (Latest) No
PHP 8.4Supported No
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes