imap_sort
Function • Removed in PHP 8.4
Gets and sort messages.
imap_sort Function synopsis
imap_sort(
IMAP\Connection $imap,
int $criteria,
bool $reverse,
int $flags = 0,
?string $search_criteria = null,
?string $charset = null
): array|false
Parameters
$imap
TypeIMAP\Connection
$criteria
Typeint
Criteria can be one (and only one) of the following:
$reverse
Typebool
Whether to sort in reverse order.
$flags
OptionalTypeintDefault value0
The $flags are a bitmask of one or more of the
following:
$search_criteria
OptionalType?stringDefault valuenull
IMAP2-format search criteria string. For details see
imap_search.
$charset
OptionalType?stringDefault valuenull
MIME character set to use when sorting strings.
Return value
Typearray|false
Returns an array of message numbers sorted by the given
parameters, or false on failure.
Changes to the imap_sort Function
PHP 8.4
- Function removed
PHP 8.1
- Parameter type added for parameter #1 (
$imap):IMAP\Connection
imap_sort(
- $imap,
+ IMAP\Connection $imap,
int $criteria,
bool $reverse,
int $flags = 0,
?string $search_criteria = null,
?string $charset = null
): array|false PHP 8.0
- Return type added:
array|false - Parameter name of parameter #1 changed:
$stream_idto$imap - Parameter type added for parameter #2 (
$criteria):int - Parameter type added for parameter #3 (
$reverse):bool - Parameter name of parameter #4 changed:
$optionsto$flags - Parameter type added for parameter #4 (
$flags):int - Parameter default value added for position #4 (
$flags):0 - Parameter type added for parameter #5 (
$search_criteria):?string - Parameter default value added for position #5 (
$search_criteria):null - Parameter type added for parameter #6 (
$charset):?string - Parameter default value added for position #6 (
$charset):null
imap_sort(
- $stream_id,
+ $imap,
- $criteria,
+ int $criteria,
- $reverse,
+ bool $reverse,
- $options,
+ int $flags = 0,
- $search_criteria,
+ ?string $search_criteria = null,
- $charset
+ ?string $charset = null
- )
+ ): array|false imap_sort Function Availability
imap_sort Function Availability| PHP Version | Availability |
|---|---|
| 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 |