List all the subscribed mailboxes

Descrierea

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

Gets information about the subscribed mailboxes.

Identical to imap_getmailboxes(), except that it only returns mailboxes that the user is subscribed to.

Parametri

imap_stream

Un flux IMAP întors de imap_open().

ref

ref should normally be just the server specification as described in imap_open()

Avertizare

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

pattern

Specifică poziția în ierarhia cutiilor poștale de unde va începe căutarea.

Sunt două caractere speciale pe care puteți să le transmiteți în cadrul pattern: '*' și '%'. '*' înseamnă a returna toate cutiile poștale. Dacă transmiteți pattern ca '*', veți obține o listă a întregii ierarhii a cutiilor poștale. '%' înseamnă a întoarce doar nivelul curent. '%' în calitate de pattern va întoarce doar cutiile poștale de la nivelul superior; '~/mail/%' pe UW_IMAPD va întoarce toate cutiile poștale în directorul ~/mail, dar nici una din submapele acstui director.

Valorile întoarse

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.