imap_sort
(PHP 4, PHP 5, PHP 7)
imap_sort — Получить и отсортировать сообщения
Описание
$imap_stream
, int $criteria
, int $reverse
, int $options
= 0
, string $search_criteria
= null
, string $charset
= null
) : array|falseПолучает и сортирует номера сообщений в соответствии с заданными параметрами.
Список параметров
-
imap_stream
-
Поток IMAP, полученный из imap_open().
-
criteria
-
Одно (и только одно) из следующих значений:
-
SORTDATE
- сортировать по дате -
SORTARRIVAL
- дата получения -
SORTFROM
- по первому адресу в поле From -
SORTSUBJECT
- по теме письма -
SORTTO
- по первому адресу в поле To -
SORTCC
- по первому адресу в поле cc -
SORTSIZE
- по размеру сообщения
-
-
reverse
-
Для получения обратной сортировки установите равным 1
-
options
-
Параметр
options
задается битовой маской одной или нескольких констант:-
SE_UID
- возвращать UID, а не номера сообщений -
SE_NOPREFETCH
- не извлекать найденые сообщения
-
-
search_criteria
-
Строка с поисковой критерией в формате IMAP2. Подробнее смотрите в описании функции imap_search().
-
charset
-
Кодировка MIME для использования при сортировке строк.
Возвращаемые значения
Возвращает массив номеров сообщений, отсортированных в соответствии с заданными
параметрами, или false
в случае возникновения ошибки.