(PHP 4, PHP 5, PHP 7, PHP 8)

imap_getsubscribedList all the subscribed mailboxes


imap_getsubscribed(IMAP\Connection $imap, string $reference, string $pattern): array|false

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


An IMAP\Connection instance.


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


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


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.
  • 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.
The function returns false on failure.

Log delle modifiche

Versione Descrizione
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected.
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top