PHP 8.4.2 Released!

imap_listscan

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

imap_listscanПолучает список почтовых ящиков, имена которых содержат заданную строку

Описание

imap_listscan(
    IMAP\Connection $imap,
    string $reference,
    string $pattern,
    string $content
): array|false

Возвращает массив, содержащий имена почтовых ящиков содержащих content в тексте.

Эта функция похожа на imap_listmailbox(), но также выявляет присутствие строки content внутри данных почтового ящика.

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

imap

Экземпляр класса IMAP\Connection.

reference

В reference, как правило, должна быть указана только спецификация сервера, как описано в imap_open()

Внимание

Передача в этот параметр непроверенных данных небезопасна, если включили директиву imap.enable_insecure_rsh.

pattern

Определяет начало поиска в иерархии почтовых ящиков.

Как часть параметра pattern перадают два специальных символа: '*' и '%'. Символ '*' означает возврат всех почтовых ящиков. Если передать параметр pattern как '*', возвращается полный список иерархии почтовых ящиков. Символ '%' означает возврат только текущего уровня. Символ '%' как значение параметра pattern вернёт почтовые ящики только верхнего уровня; с серверов UW_IMAPD значение '~/mail/%' вернёт почтовые ящики каталога ~/mail, но не подкаталогов этого каталога.

content

Искомая строка

Возвращаемые значения

Возвращает массив, содержащий имена почтовых ящиков содержащих content в тексте или false, если возникла ошибка.

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.

Смотрите также

  • imap_listmailbox() - Псевдоним imap_list
  • imap_search() - Получает сообщения, удовлетворяющие заданным критериям

Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы
To Top