imap_lsub
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_lsub — Получает список всех почтовых ящиков, на которые оформлена подписка
Описание
Возвращает массив всех почтовых ящиков на которые вы подписаны.
Список параметров
-
imap -
Экземпляр IMAP\Connection.
-
reference -
В
reference, как правило, должна быть указана только спецификация сервера, как описано в imap_open().ВниманиеЕсли imap.enable_insecure_rsh не отключён, то передача в этот параметр не проверенных данных не безопасна.
-
pattern -
Определяет начало поиска в иерархии почтовых ящиков.
Есть два специальных символа, которые можно использовать при передаче как часть
pattern: '*' и '%'. '*' возвращает все почтовые ящики. Если вы передадитеpatternкак '*', то получите полный список иерархии почтовых ящиков. '%' вернёт только текущий уровень. '%', переданный как параметрpattern, вернёт почтовые ящики только на самом верхнем уровне; '~/mail/%' наUW_IMAPDвернёт все ящики в директории ~/mail, кроме тех, которые находятся в её поддиректориях.
Возвращаемые значения
Возвращает массив всех подписанных почтовых ящиков или false в случае возникновения ошибки.
Список изменений
| Версия | Описание |
|---|---|
| 8.1.0 |
Параметр imap теперь ожидает экземпляр IMAP\Connection; ранее ожидался ресурс (resource) imap.
|
Смотрите также
- imap_list() - Читает список почтовых ящиков
- imap_getmailboxes() - Читает список почтовых ящиков, возвращая подробную информацию по каждому из них
add a note
