imap_list

Function • Removed in PHP 8.4

Read the list of mailboxes.

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

imap_list(
    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 containing the names of the mailboxes or false in case of failure.

Changes to the imap_list Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_list(
-     $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_list(
-     $stream_id,
+     $imap,
-     $ref,
+     string $reference,
-     $pattern
+     string $pattern
-   )
+   ): array|false

imap_list 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