(PHP 4, PHP 5, PHP 7, PHP 8)
imap_getsubscribed — List all the subscribed mailboxes
Gets information about the subscribed mailboxes.
Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.
imap
Примірник IMAP\Connection.
reference
reference
should normally be just the server
specification as described in imap_open()
Передавати у цей параметр неперевірені дані небезпечно, якщо увімкнено imap.enable_insecure_rsh.
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.
LATT_REFERRAL
- This container has a referral to a remote mailbox.
LATT_HASCHILDREN
- This mailbox has selectable inferiors.
LATT_HASNOCHILDREN
- This mailbox has no selectable inferiors.
false
on failure.
Версія | Опис |
---|---|
8.1.0 |
Тепер параметр imap має бути примірником
IMAP\Connection; раніше очікувався дійсний resource
imap .
|