Submit a Pull Request Report a Bug

    imap_getsubscribed

    (PHP 4, PHP 5, PHP 7)

    imap_getsubscribed — List all the subscribed mailboxes

    Opis

    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.

    Parametry

    imap_stream

    Strumień IMAP zwrócony przez imap_open().

    ref

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

    Ostrzeżenie

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

    pattern

    Określa gdzie w hierarchii skrzynki rozpocząć wyszukiwanie.

    Istnieją dwa specjalne znaki, które możesz przekazać jako część argumentu pattern: '*' i '%'. '*' oznacza zwrócenie wszystkich skrzynek. Jeżeli jako argument pattern ustawiony na '*' zwróci pełną hierarchię skrzynki mailowej. '%' oznacza zwrócenie tylko obecnego poziomu. '%' jako parametr pattern zwróci tylko skrzynki mailowe najwyższego poziomu; '~/mail/%' na UW_IMAPD zwróci każdą skrzynkę w katalogu ~/mail, ale nie w jego podkatalogach.

    Zwracane wartości

    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.

    add a note add a note

    User Contributed Notes

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