imap_status

Function • Removed in PHP 8.4

Returns status information on a mailbox.

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_status Function synopsis

imap_status(
    IMAP\Connection $imap,
    string $mailbox,
    int $flags
  ): stdClass|false

Parameters

$imap

TypeIMAP\Connection

$mailbox

Typestring

The mailbox name, see imap_open for more information

$flags

Typeint

Valid flags are:

Return value

TypestdClass|false

This function returns an object containing status information, or false on failure. The object has the following properties: messages, recent, unseen, uidnext, and uidvalidity.

flags is also set, which contains a bitmask which can be checked against any of the above constants.

Changes to the imap_status Function

PHP 8.4

  • Function removed

PHP 8.1

  • Return type added: stdClass|false
  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_status(
-     $imap,
+     IMAP\Connection $imap,
      string $mailbox,
      int $flags
-   )
+   ): stdClass|false

PHP 8.0

  • Parameter name of parameter #1 changed: $stream_id to $imap
  • Parameter type added for parameter #2 ($mailbox): string
  • Parameter name of parameter #3 changed: $options to $flags
  • Parameter type added for parameter #3 ($flags): int
  imap_status(
-     $stream_id,
+     $imap,
-     $mailbox,
+     string $mailbox,
-     $options
+     int $flags
    )

imap_status 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