PHP 8.4.0 RC4 available for testing

imap_getsubscribed

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

imap_getsubscribedПолучает список всех почтовых ящиков, на которые оформлена подписка

Описание

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

Функция возвращает информацию о почтовых ящиках, на которые оформили подписку.

Функция работает идентично функции imap_getmailboxes(), за исключением того, что возвращается только список ящиков, на которые подписался пользователь.

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

imap

Экземпляр класса IMAP\Connection.

reference

В параметре reference обычно просто указывают спецификацию сервера, как описывает страница функции imap_open().

Внимание

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

pattern

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

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

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

Возвращает массив объектов, содержащих информацию о ящиках. Каждый объект имеет свойства: name, содержащее полное имя ящика; delimiter, содержащее разделитель для той части иерархии, в которой содержится ящик; и attributes. Параметр Attributes является битовой маской, следующих допустимых констант:

  • LATT_NOINFERIORS — Этот ящик не имеет потомков (нет ни одного ящика ниже этого).
  • LATT_NOSELECT — Это только контейнер, а не почтовый ящик. Вы не можете его открыть.
  • LATT_MARKED — Этот ящик помечен. Используется только UW-IMAPD.
  • LATT_UNMARKED — Этот ящик не помечен. Используется только UW-IMAPD.
  • LATT_REFERRAL — Этот контейнер имеет направления (referral) на удалённый почтовый ящик.
  • LATT_HASCHILDREN — Этот почтовый ящик имеет выбираемые подчинённые (inferiors).
  • LATT_HASNOCHILDREN — Этот почтовый ящик не имеет выбираемые подчинённые (inferiors).
Функция возвращает false, если возникла ошибка.

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

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

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы
To Top