PHP 8.3.7 Released!

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 вернёт почтовые ящики только верхнего уровня; с серверов UW_IMAPD значение '~/mail/%' вернёт почтовые ящики каталога ~/mail, но не подкаталогов этого каталога.

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

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

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.

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

  • imap_list() - Читает список почтовых ящиков
  • imap_getmailboxes() - Читает список почтовых ящиков и возвращает подробную информацию о каждом из них

add a note

User Contributed Notes

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