PHP 8.5.0 Alpha 2 available for testing

    imap_getsubscribed

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

    imap_getsubscribed — Lista todas las carpetas de correo suscritas

    Descripción

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

    Lista todas las carpetas de correo suscritas.

    imap_getsubscribed() es idéntico a imap_getmailboxes(), pero solo devuelve las carpetas de correo a las que el usuario está suscrito.

    Parámetros

    imap

    An IMAP\Connection instance.

    reference

    reference debe ser solo el servidor en la forma descrita en imap_open()

    Advertencia

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

    pattern

    Specifies where in the mailbox hierarchy to start searching.

    There are two special characters you can pass as part of the pattern: '*' and '%'. '*' means to return all mailboxes. If you pass pattern as '*', you will get a list of the entire mailbox hierarchy. '%' means to return the current level only. '%' as the pattern parameter will return only the top level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory.

    Valores devueltos

    Devuelve un array de objetos que contienen información sobre las carpetas de correo. Cada objeto posee un atributo de name, que contiene el nombre completo de la carpeta de correo, delimiter que es el delimitador jerárquico y attributes. attributes es una máscara de bits, que contiene :

    • LATT_NOINFERIORS - Esta carpeta de correo no tiene "hijos" (no hay más carpetas de correo debajo de esta).
    • LATT_NOSELECT - Esto es solo un contenedor, no una carpeta de correo (no se puede abrir).
    • LATT_MARKED - Esta carpeta de correo está marcada. Utilizado únicamente con UW-IMAPD.
    • LATT_UNMARKED - Esta carpeta de correo no está marcada. Utilizado únicamente con UW-IMAPD.
    • LATT_REFERRAL - Este contenedor tiene una referencia a una carpeta de correo remota.
    • LATT_HASCHILDREN - Esta carpeta de correo tiene inferiores seleccionables.
    • LATT_HASNOCHILDREN - Esta carpeta de correo no tiene inferiores seleccionables.
    La función devuelve false en caso de fallo.

    Historial de cambios

    Versión Descripción
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

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