(PHP 4, PHP 5, PHP 7, PHP 8)
imap_getsubscribed — Lista todas las carpetas de correo suscritas
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.
imap
An IMAP\Connection instance.
reference
reference
debe ser solo el servidor
en la forma descrita en imap_open()
El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.
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 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.
false
en caso de fallo.
Versión | Descripción |
---|---|
8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a valid imap recurso was expected.
|