array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'function.imap-listscan.php', 1 => 'imap_listscan', 2 => 'Получает список почтовых ящиков, имена которых содержат заданную строку', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'Функции IMAP', ), 'prev' => array ( 0 => 'function.imap-listmailbox.php', 1 => 'imap_listmailbox', ), 'next' => array ( 0 => 'function.imap-listsubscribed.php', 1 => 'imap_listsubscribed', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/imap/functions/imap-listscan.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

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.

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