imap_listscan

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

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

Описание

imap_listscan ( resource $imap , string $reference , string $pattern , string $content ) : array|false

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

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

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

imap

Поток IMAP, полученный из imap_open().

reference

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

Внимание

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

pattern

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

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

content

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

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

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

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

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

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top