(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.
imapreference
reference debería ser solo el servidor
en la forma descrita en imap_open()
Pasar datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté desactivado.
patternpattern:
'*' y '%'.
'*' significa devolver todos los buzones. Si se pasa
pattern como '*', se obtendrá
una lista de toda la jerarquía del buzón.
'%'
significa devolver solo el nivel actual.
'%' como parámetro pattern
devolverá solo los buzones de nivel
superior; '~/mail/%' en UW_IMAPD devolverá cada buzón en el directorio ~/mail, pero ninguno en las subcarpetas de ese directorio.
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 |
El parámetro imap ahora espera una instancia de IMAP\Connection
; anteriormente, se esperaba un resource imap válido.
|
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);
?>i am currently develop a simple IMAP client, when i call imap_getmailboxes() i receive a different values in attributes property of the mailbox object the problem is how can i manipulate these attributes to get a meaningful value,
if you make a hard search to find a solution for this, you will
not find any useful documents for this problem, let us take a closer look for this problem.
when i call imap_getmailboxes() against different IMAP servers i got these attribute values
[attributes] => 9
[attributes] => 1
[attributes] => 64
[attributes] => 32
[attributes] => 40
the documentation tell us that we check this attributes against four constants, these contents are
LATT_NOINFERIORS
LATT_NOSELECT
LATT_MARKED
LATT_UNMARKED
the value of these constants are
LATT_NOINFERIORS = 1
LATT_NOSELECT = 2
LATT_MARKED = 4
LATT_UNMARKED = 8
you can got this result by echo each constant, unfortunately the documentation not explain how we can check the attributes against the constants, after a long time of searching i find the answer in source code of c-client
(you can get the source from ftp://ftp.cac.washington.edu/imap/)
under \src\c-client you will find mail.h open it and you will find this
/* terminal node in hierarchy */
#define LATT_NOINFERIORS (long) 0x1
/* name can not be selected */
#define LATT_NOSELECT (long) 0x2
/* changed since last accessed */
#define LATT_MARKED (long) 0x4
/* accessed since last changed */
#define LATT_UNMARKED (long) 0x8
/* name has referral to remote mailbox */
#define LATT_REFERRAL (long) 0x10
/* has selectable inferiors */
#define LATT_HASCHILDREN (long) 0x20
/* has no selectable inferiors */
#define LATT_HASNOCHILDREN (long) 0x40
as you notice here these are our four constants and three additional constants
LATT_REFERRAL
LATT_HASCHILDREN
LATT_HASNOCHILDREN
then what is the value of these 3 attributes
LATT_REFERRAL 0x10 = 00010000 in binary, the bitmask value is 2^4 = 16 and so on, or simply echo this constant to get the value, then
LATT_REFERRAL = 16
LATT_HASCHILDREN = 32
LATT_HASNOCHILDREN = 64
finally the full list of constants will be
LATT_NOINFERIORS = 1
LATT_NOSELECT = 2
LATT_MARKED = 4
LATT_UNMARKED = 8
LATT_REFERRAL = 16
LATT_HASCHILDREN = 32
LATT_HASNOCHILDREN = 64
ok let's back to our attributes
[attributes] => 9
[attributes] => 1
[attributes] => 64
[attributes] => 32
[attributes] => 40
[attributes] => 9 this mean it's LATT_UNMARKED and LATT_NOINFERIORS 1+8 =9
[attributes] => 1 this mean LATT_NOINFERIORS
[attributes] => 64 this mean LATT_HASNOCHILDREN
[attributes] => 32 this mean LATT_HASCHILDREN
[attributes] => 40 this mean LATT_HASCHILDREN and LATT_UNMARKED 32+8=40
this just like linux file permission 7 mean read, write, and execute 4+2+1 read=4 write=2 execute=1
that is what i found, i hope this can help
Mohamed Abbas
Nileweb EgyptThe list of mailbox attributes in this document is very misleading. In particular the explanation of noinferiors is just wrong. It does not mean that the mailbox currently has no children, it means that it *cannot* have children ever. Also, it is untrue that marked and unmarked are only used by UW-IMAP. They are in the official IMAP specification and are used by at least Courier-imap as well.
One thing to watch out for, however, is broken IMAP servers which do send \Noinferiors when they mean that there are currently no children.
From the IMAP4rev1 specs (RFC 2060):
\Noinferiors
It is not possible for any child levels of hierarchy to exist
under this name; no child levels exist now and none can be
created in the future.
\Noselect
It is not possible to use this name as a selectable mailbox.
\Marked
The mailbox has been marked "interesting" by the server; the
mailbox probably contains messages that have been added since
the last time the mailbox was selected.
\Unmarked
The mailbox does not contain any additional messages since the
last time the mailbox was selected.In case you print_r() or var_dump() the object and see an int for attribute, these are the constant integers for the bitmask.
1 LATT_NOINFERIORS
2 LATT_NOSELECT
4 LATT_MARKED
8 LATT_UNMARKED