Submit a Pull Request Report a Bug

    imap_getsubscribed

    (PHP 4, PHP 5)

    imap_getsubscribed — List all the subscribed mailboxes

    說明

    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.

    參數

    imap_stream

    由 imap_open() 傳回的 IMAP 串流。

    ref

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

    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.

    add a note add a note

    User Contributed Notes

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