imap_getmailboxes

Function • Removed in PHP 8.4

Read the list of mailboxes, returning detailed information on each one.

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

imap_getmailboxes(
    IMAP\Connection $imap,
    string $reference,
    string $pattern
  ): array|false

Parameters

$imap

TypeIMAP\Connection

$reference

Typestring

$reference should normally be just the server specification as described in imap_open

$pattern

Typestring

Return value

Typearray|false

Returns an array of objects containing mailbox information. Each object has the attributes $name, specifying the full name of the mailbox; $delimiter, which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and $attributes. $Attributes is a bitmask that can be tested against:

The function returns false on failure.

  [`LATT_NOINFERIORS`](/codex/LATT_NOINFERIORS) - This mailbox not contains, and may not contain any
  "children" (there are no mailboxes below this one). Calling 
  [`imap_createmailbox`](/codex/imap_createmailbox) will not work on this mailbox.

  [`LATT_NOSELECT`](/codex/LATT_NOSELECT) - This is only a container,
  not a mailbox - you cannot open it.

  [`LATT_MARKED`](/codex/LATT_MARKED) - This mailbox is marked. This means that it may 
  contain new messages since the last time it was checked. Not provided by all IMAP
  servers.

  [`LATT_UNMARKED`](/codex/LATT_UNMARKED) - This mailbox is not marked, does not contain new
  messages.  If either [`MARKED`](/codex/MARKED) or [`UNMARKED`](/codex/UNMARKED) is
  provided, you can assume the IMAP server  supports this feature for this mailbox.

  [`LATT_REFERRAL`](/codex/LATT_REFERRAL) - This container has a referral to a remote mailbox.

  [`LATT_HASCHILDREN`](/codex/LATT_HASCHILDREN) - This mailbox has selectable inferiors.

  [`LATT_HASNOCHILDREN`](/codex/LATT_HASNOCHILDREN) - This mailbox has no selectable inferiors.

Changes to the imap_getmailboxes Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_getmailboxes(
-     $imap,
+     IMAP\Connection $imap,
      string $reference,
      string $pattern
    ): array|false

PHP 8.0

  • Return type added: array|false
  • Parameter name of parameter #1 changed: $stream_id to $imap
  • Parameter name of parameter #2 changed: $ref to $reference
  • Parameter type added for parameter #2 ($reference): string
  • Parameter type added for parameter #3 ($pattern): string
  imap_getmailboxes(
-     $stream_id,
+     $imap,
-     $ref,
+     string $reference,
-     $pattern
+     string $pattern
-   )
+   ): array|false

imap_getmailboxes 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