imap_getmailboxes

(PHP 4, PHP 5)

imap_getmailboxes — Lee la lista de buzones, devolviendo informacón detallada de cada uno

Descripción

array imap_getmailboxes ( int $imap_stream , string $ref , string $pat )

Devuelve un array de objetos coneniendo información del buzón. Cada objeto tiene los atributos name , especificando el nombre completo del buzón; delimiter , que es el delimitador jerárquico para la parte de la jerarquía dónde está este buzón; y attributes . Attributes es una máscara de bits contra la que se puede probar:

LATT_NOINFERIORS - Este buzón no tiene "hijos" (No ha buzones por debajo de él)
LATT_NOSELECT - Esto es sólo un contenedor, no un buzón - No puede abrirlo.
LATT_MARKED - Este buzón está marcado. Unicamente usado por UW-IMAPD.
LATT_UNMARKED - Este buzón no está marcado. Unicamente usado por UW-IMAPD.

ref normalmente debería ser solo el servidor IMAP, de la forma: {imap_server:imap_port}, y pattern especifica, dónde en la estructura jerárquica del buzón, para comenzar a buscar. Si quiere todo los buzones, pase el parámetro pattern como una cadena vacía.

Hay dos caracteres especiales que puede pasar como parte del parámetro pattern : '*' and '%'. '*' significa que devuelva todos los buzones. Si pasa el parámetro pattern como '*', obtendrá una lista con la jerarquía completa del buzón. %' significa que devuelva sólo el nivel actual. Pasar '%' en el parámetro pattern devolverá sólo el nivel más alto de los buzones; '~/mail/%' en UW_IMAPD devolverá cada buzón del directorio ~/mail, pero ninguno de los subdirectorios de ese directorio.