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