imap_search

Function • Removed in PHP 8.4

This function returns an array of messages matching the given search criteria.

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

imap_search(
    IMAP\Connection $imap,
    string $criteria,
    int $flags = SE_FREE,
    string $charset = ""
  ): array|false

Parameters

$imap

TypeIMAP\Connection

$criteria

Typestring

A string, delimited by spaces, in which the following keywords are allowed. Any multi-word arguments (e.g. FROM "joey smith") must be quoted. Results will match all $criteria entries.

$flags

OptionalTypeintDefault valueSE_FREE

Valid values for $flags are SE_UID, which causes the returned array to contain UIDs instead of messages sequence numbers.

$charset

OptionalTypestringDefault value""

MIME character set to use when searching strings.

Return value

Typearray|false

Returns an array of message numbers or UIDs.

Return false if it does not understand the search $criteria or no messages have been found.

Changes to the imap_search Function

PHP 8.4

  • Function removed

PHP 8.1

  • Parameter type added for parameter #1 ($imap): IMAP\Connection
  imap_search(
-     $imap,
+     IMAP\Connection $imap,
      string $criteria,
      int $flags = SE_FREE,
      string $charset = ""
    ): 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 ($criteria): 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): SE_FREE
  • Parameter type added for parameter #4 ($charset): string
  • Parameter default value added for position #4 ($charset): ""
  imap_search(
-     $stream_id,
+     $imap,
-     $criteria,
+     string $criteria,
-     $options,
+     int $flags = SE_FREE,
-     $charset
+     string $charset = ""
-   )
+   ): array|false

imap_search 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