imap_listscan
(PHP 4, PHP 5, PHP 7)
imap_listscan — Получить список почтовых ящиков, имена которых содержат заданную строку
Описание
$imap_stream
, string $ref
, string $pattern
, string $content
) : array
Возвращает массив, содержащий имена почтовых ящиков содержащих
content в тексте.
Эта функция похожа на imap_listmailbox(),
но также выявляет присутствие строки content
внутри данных почтового ящика.
Список параметров
-
imap_stream -
Поток IMAP, полученный из imap_open().
-
ref -
В
ref, как правило, должна быть указана только спецификация сервера, как описано в imap_open()ВниманиеЕсли imap.enable_insecure_rsh не отключен, то передача в этот параметр не проверенных данных не безопасна.
-
pattern -
Определяет начало поиска в иерархии почтовых ящиков.
Есть два специальных символа, которые можно использовать при передаче как часть
pattern: '*' и '%'. '*' возвращает все почтовые ящики. Если вы передадитеpatternкак '*', то получите полный список иерархии почтовых ящиков. '%' вернет только текущий уровень. '%', переданный как параметрpattern, вернет почтовые ящики только на самом верхнем уровне; '~/mail/%' наUW_IMAPDвернет все ящики в директории ~/mail, кроме тех, которые находятся в ее поддиректориях. -
content -
Искомая строка
Возвращаемые значения
Возвращает массив, содержащий имена почтовых ящиков содержащих
content в тексте.
Смотрите также
- imap_listmailbox() - Псевдоним imap_list
- imap_search() - Получить сообщения, удовлетворяющие заданным критериям