imap_fetch_overview

Function • Removed in PHP 8.4

Read an overview of the information in the headers of the given message.

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

imap_fetch_overview(
    IMAP\Connection $imap,
    string $sequence,
    int $flags = 0
  ): array|false

Parameters

$imap

TypeIMAP\Connection

$sequence

Typestring

A message sequence description. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an interval with the X:Y syntax

$flags

OptionalTypeintDefault value0

$sequence will contain a sequence of message indices or UIDs, if this parameter is set to FT_UID.

Return value

Typearray|false

Returns an array of objects describing one message header each. The object will only define a property if it exists. The possible properties are:

The function returns false on failure.

Changes to the imap_fetch_overview Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_fetch_overview(
-     $imap,
+     IMAP\Connection $imap,
      string $sequence,
      int $flags = 0
    ): array|false

PHP 8.0

  • Return type added: array|false
  • Parameter name of parameter #1 changed: $stream_id to $imap
  • Parameter type added for parameter #2 ($sequence): string
  • Parameter name of parameter #3 changed: $options to $flags
  • Parameter type added for parameter #3 ($flags): int
  • Parameter default value added for position #3 ($flags): 0
  imap_fetch_overview(
-     $stream_id,
+     $imap,
-     $sequence,
+     string $sequence,
-     $options
+     int $flags = 0
-   )
+   ): array|false

imap_fetch_overview 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