imap_getsubscribed - List all the subscribed mailboxes
Вернуться к: IMAP Функции
imap_getsubscribed
(PHP 4, PHP 5, PHP 7)
imap_getsubscribed — List all the subscribed mailboxes
Описание
$imap_stream
, string $ref
, string $pattern
)Gets information about the subscribed mailboxes.
Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.
Список параметров
-
imap_stream -
Поток IMAP, полученный из imap_open().
-
ref -
refshould normally be just the server specification as described in imap_open() -
pattern -
Определяет начало поиска в иерархии почтовых ящиков.
Есть два специальных символа, которые можно использовать при передаче как часть
pattern: '*' и '%'. '*' возвращает все почтовые ящики. Если вы передадитеpatternкак '*', то получите полный список иерархии почтовых ящиков. '%' вернет только текущий уровень. '%', переданный как параметрpattern, вернет почтовые ящики только на самом верхнем уровне; '~/mail/%' на UW_IMAPD вернет все ящики в директории ~/mail, кроме тех, которые находятся в ее поддиректориях.
Возвращаемые значения
Returns an array of objects containing mailbox information. Each
object has the attributes name, specifying
the full name of the mailbox; delimiter,
which is the hierarchy delimiter for the part of the hierarchy
this mailbox is in; and
attributes. Attributes
is a bitmask that can be tested against:
-
LATT_NOINFERIORS- This mailbox has no "children" (there are no mailboxes below this one). -
LATT_NOSELECT- This is only a container, not a mailbox - you cannot open it. -
LATT_MARKED- This mailbox is marked. Only used by UW-IMAPD. -
LATT_UNMARKED- This mailbox is not marked. Only used by UW-IMAPD.
Вернуться к: IMAP Функции