imap_sort

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

imap_sort — Отримує та сортує повідомлення

Опис

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

Отримує та сортує номери повідомлень відповідно до заданих параметрів.

Список параметрів

imap

Екземпляр IMAP\Connection

criteria

Одне (і лише одне) з наступних значень:

  • **SORTDATE**- сортувати за датою
  • **SORTARRIVAL**- дата отримання
  • **SORTFROM**- за першою адресою у полі From
  • **SORTSUBJECT**- на тему листа
  • **SORTTO**- на першу адресу в полі To
  • **SORTCC**- за першою адресою в полі cc
  • **SORTSIZE**- за розміром повідомлення

reverse

Визначає сортування у зворотному порядку.

flags

Параметрflags задається бітовою маскою однієї або кількох констант:

  • **SE_UID**- повертати UID, а не номери повідомлень
  • **SE_NOPREFETCH**- не отримувати знайдені повідомлення

search_criteria

Рядок з пошуковим критерієм у форматі IMAP2. Докладніше дивіться в описі функції imap_search()

charset

Кодування MIME для сортування рядків.

Значення, що повертаються

Повертає масив номерів повідомлень, відсортованих відповідно до заданих параметрів або **false**в случае возникновения ошибки.

список змін

ВерсияОпис
8.1.0Параметрimap тепер чекає екземпляр IMAP\Connection; раніше очікувався ресурс (resourceimap
8.0.0reverse тепер є логічним типом (Bool) замість цілого числа (int).
8.0.0search_criteriaиcharset тепер є nullable.