(PHP 4, PHP 5, PHP 7, PHP 8)
imap_lsub — Listar todos los buzones suscritos
$imap_stream
, string $ref
, string $pattern
): arrayObtiene un array de todos lo buzones que tiene suscritos.
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.
Devuelve un array de todos los buzones suscritos.