PHP 8.1.0 RC 4 available for testing

imap_lsub

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

imap_lsubСписок всех подписанных почтовых ящиков

Описание

imap_lsub(IMAP\Connection $imap, string $reference, string $pattern): array|false

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

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

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_list() - Прочитать список почтовых ящиков
  • imap_getmailboxes() - Прочитать список почтовых ящиков, возвращая подробную информацию по каждому из них

add a note add a note

User Contributed Notes

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