Submit a Pull Request Report a Bug

    imap_getsubscribed

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

    imap_getsubscribed — List all the subscribed mailboxes

    Descrição

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

    Parâmetros

    imap_stream

    Um stream IMAP retornado por imap_open().

    reference

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

    Aviso

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

    pattern

    Especifica aonde na hierarquia da caixa de mensagens deve começar a procura.

    Existem dois caracteres especiais que você pode passar como parte para o pattern: '*' e '%'. '*' significa retornar todas as caixas de mensagens. Se você passar pattern como '*', você terá uma lista de toda a hierarquia da caixa de mensagens. '%' significa retornar o nível atual apenas. '%' como o parâmetro pattern ira retornar apenas as caixar de mensagem do nível superior; '~/mail/%' em UW_IMAPD irá retornar cada caixa de mensagem no diretório ~/mail, mais nenhuma em subpastas deste diretório.

    Valor Retornado

    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.

    add a note add a note

    User Contributed Notes

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