imap_getsubscribed

Function • Removed in PHP 8.4

List all the subscribed 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_getsubscribed Function synopsis

imap_getsubscribed(
    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.

Changes to the imap_getsubscribed Function

PHP 8.4

  • Function removed

PHP 8.1

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

imap_getsubscribed 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