imap_getsubscribed

(PHP 4, PHP 5, PHP 7)

imap_getsubscribed — Список всех почтовых ящиков, на которые вы подписаны

Описание

imap_getsubscribed ( resource $imap_stream , string $ref , string $pattern ) : array

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

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

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

imap_stream

Поток IMAP, полученный из imap_open().

ref

В ref, как правило, должна быть указана только спецификация сервера, как описано в 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).