imap_close

Function • Removed in PHP 8.4

Close an IMAP stream.

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

imap_close Function synopsis

imap_close(IMAP\Connection $imap, int $flags = 0): true

Parameters

$imap

TypeIMAP\Connection

$flags

OptionalTypeintDefault value0

If set to CL_EXPUNGE, the function will silently expunge the mailbox before closing, removing all messages marked for deletion. You can achieve the same thing by using imap_expunge

$flags accepts the following constant value

Return value

Typetrue

Always returns true

Changes to the imap_close Function

PHP 8.4

  • Function removed

PHP 8.3

  • Return type changed: bool to true
- imap_close(IMAP\Connection $imap, int $flags = 0): bool
+ imap_close(IMAP\Connection $imap, int $flags = 0): true

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
- imap_close($imap, int $flags = 0): bool
+ imap_close(IMAP\Connection $imap, int $flags = 0): bool

PHP 8.0

  • Return type added: bool
  • Parameter name of parameter #1 changed: $stream_id to $imap
  • Parameter name of parameter #2 changed: $options to $flags
  • Parameter type added for parameter #2 ($flags): int
  • Parameter default value added for position #2 ($flags): 0
- imap_close($stream_id, $options)
+ imap_close($imap, int $flags = 0): bool

imap_close 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