(PHP 4, PHP 5, PHP 7, PHP 8)
imap_getmailboxes — Lista los buzones de correo y devuelve los detalles de cada uno
Lista los buzones de correo.
imapAn IMAP\Connection instance.
reference
reference debería ser solo el servidor
en la forma descrita en imap_open()
Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
patternSpecifies 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.
Devuelve un array de objetos que contienen información sobre los
buzones de correo. Cada objeto posee un atributo de
name, que contiene el nombre completo
del buzón de correo, delimiter que
es el delimitador jerárquico y attributes.
attributes es una máscara de bits, que contiene :
LATT_NOINFERIORS - Este buzón de correo
no tiene "hijos" (no hay más buzones de correo
debajo de este) y no puede contener ninguno. Una llamada a la
función imap_createmailbox() no funcionará
en este buzón.
LATT_NOSELECT - Esto es solo un contenedor,
no un buzón de correo (no se puede abrir).
LATT_MARKED - Este buzón de correo está marcado.
Esto significa que puede contener nuevos mensajes desde la última
vez que fue verificado. Este marcador no se proporciona con todos los
servidores IMAP.
LATT_UNMARKED - Este buzón de correo no está
marcado y no contiene nuevos mensajes. Si
MARKED o UNMARKED se proporciona,
se puede asumir que el servidor IMAP soporta esta funcionalidad
para este buzón de correo.
LATT_REFERRAL - Este contenedor tiene una referencia a un buzón de correo remoto.
LATT_HASCHILDREN - Este buzón de correo tiene inferiores seleccionables.
LATT_HASNOCHILDREN - Este buzón 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 resource was expected.
|
Ejemplo #1 Ejemplo con imap_getmailboxes()
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("Conexión imposible: " . imap_last_error());
$list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
foreach ($list as $key => $val) {
echo "($key) ";
echo imap_utf7_decode($val->name) . ",";
echo "'" . $val->delimiter . "',";
echo $val->attributes . "<br />\n";
}
} else {
echo "imap_getmailboxes ha fallado: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>