Listar todos los buzones suscritos

Descripción

imap_getsubscribed ( resource $imap_stream , string $ref , string $pattern ) : array

Obtiene información sobre los buzones suscritos.

Idéntica a imap_getmailboxes(), excepto que sólo devuelve los buzones al que está suscrito el usuario.

Parámetros

imap_stream

IMAP stream devuelto por imap_open().

ref

ref normalmente debería ser la especificación del servidor como está descrita en imap_open()

pattern

Especifica donde en la jerarquía del buzón para empezar a buscar.

Hay dos caracteres especiales que se pueden pasar como parte del pattern: '*' y '%'. '*' significa devolver todos los buzones. Si se pasa el pattern como '*', se obtendrá una lista de toda la jerarquía del buzón. '%' significa devolver sólo el nivel actual. '%' como el parámetro pattern devolverá solamente el nivel superior de los buzones; '~/mail/%' en UW_IMAPD devolverá cada buzón en el directorio ~/mail, pero no en los subdirectorios de ese directorio.

Valores devueltos

Devuelve un array de objetos de contienen información de los buzones. Cada objeto tiene los atributos name (nombre), especificando el nombre completo del buzón; delimiter (delimitador), que es el delimitador de jerarquía para la parte de jerarquía en la que está este buzón, y attributes (atributos). Attributes es una máscara de bits que puede ser comprobada con:

LATT_NOINFERIORS - Este buzón no tiene "hijos" (no hay buzones por debajo de este).
LATT_NOSELECT - Esto es solo un contenedor, no un buzón - no puede abrirlo.
LATT_MARKED - Este buzón está marcado. Solo usado por UW-IMAPD.
LATT_UNMARKED - Este buzón no está marcado. Solo usado por UW-IMAPD.