imap_getsubscribed
imap_getsubscribed
List all the subscribed mailboxes
**imap_getsubscribed** IMAP\Connection $imap string $reference string $pattern
Gets information about the subscribed mailboxes.
Identical to , except that it only
returns mailboxes that the user is subscribed to.
imap_getmailboxes
reference
should normally be just the server
specification as described in
reference``imap_open
pattern
Returns an array of objects containing mailbox information. Each object has the attributes , specifying the full name of the mailbox; , which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and . is a bitmask that can be tested against:
The function returns false on failure.
name``delimiter``attributes``Attributes- - This mailbox has no "children" (there are no mailboxes below this one). LATT_NOINFERIORS
-
- This is only a container, not a mailbox - you cannot open it.
LATT_NOSELECT
- This is only a container, not a mailbox - you cannot open it.
-
- This mailbox is marked. Only used by UW-IMAPD.
LATT_MARKED
- This mailbox is marked. Only used by UW-IMAPD.
-
- This mailbox is not marked. Only used by UW-IMAPD.
LATT_UNMARKED
- This mailbox is not marked. Only used by UW-IMAPD.
-
- This container has a referral to a remote mailbox.
LATT_REFERRAL
- This container has a referral to a remote mailbox.
-
- This mailbox has selectable inferiors.
LATT_HASCHILDREN
- This mailbox has selectable inferiors.
-
- This mailbox has no selectable inferiors.
LATT_HASNOCHILDREN
- This mailbox has no selectable inferiors.