imap_getsubscribed

(PHP 4, PHP 5)

imap_getsubscribed — List all the subscribed mailboxes

Descrizione

array imap_getsubscribed ( resource $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.

Elenco dei parametri

imap_stream

Uno stream IMAP restituito da imap_open().

ref

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

pattern

Specifica da dove, nella gerarchia della mailbox, cominciare a cercare.

Ci sono due caratteri speciali che si possono passare all'interno di pattern: '*' e '%'. '*' restituisce tutte le mailbox. Se si passa '*' in pattern, verrà restituito un elenco du tutta le gerarchia della mailbox. '%' corrisponde al solo livello attuale. '%' nel parametro pattern restituirà solo le mailbox del livello superiore; '~/mail/%' in UW_IMAPD restituirà ogni mailbox nella cartella ~/mail, ma non quelle nelle sue sottocartelle.

Valori restituiti

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.

add a note User Contributed Notes imap_getsubscribed - [0 notes]

There are no user contributed notes for this page.