PHP 8.3.6 Released!

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

User Contributed Notes

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