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; раньше параметр ждал ресурс (resource) imap.
    8.0.0reverse теперь является логическим типом (bool) вместо целого числа (int).
    8.0.0search_criteria и charset теперь являются nullable.
    To Top