imap_sort

(PHP 4, PHP 5, PHP 7, PHP 8)

imap_sortGets and sort messages

Descripción

imap_sort(
    IMAP\Connection $imap,
    int $criteria,
    bool $reverse,
    int $flags = 0,
    ?string $search_criteria = null,
    ?string $charset = null
): array|false

Gets and sorts message numbers by the given parameters.

Parámetros

imap

An IMAP\Connection instance.

criteria

Criteria can be one (and only one) of the following:

reverse

Whether to sort in reverse order.

flags

The flags are a bitmask of one or more of the following:

  • SE_UID - Return UIDs instead of sequence numbers
  • SE_NOPREFETCH - Don't prefetch searched messages

search_criteria

IMAP2-format search criteria string. For details see imap_search().

charset

MIME character set to use when sorting strings.

Valores devueltos

Returns an array of message numbers sorted by the given parameters, o false en caso de error.

Historial de cambios

Versión Descripción
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap recurso was expected.
8.0.0 reverse is now bool instead of int.
8.0.0 search_criteria and charset are now nullable.