imap_getmailboxes
Read the list of mailboxes, returning detailed information on each one
&reftitle.description;
arrayimap_getmailboxes
resourceimap_stream
stringref
stringpattern
Gets information on the mailboxes.
&reftitle.parameters;
&imap.imap-stream.description;
ref
ref should normally be just the server
specification as described in imap_open
pattern
&imap.pattern;
&reftitle.returnvalues;
Returns an array of objects containing mailbox information. Each
object has the attributes name, specifying
the full name of the mailbox; delimiter,
which is the hierarchy delimiter for the part of the hierarchy
this mailbox is in; and
attributes. Attributes
is a bitmask that can be tested against:
LATT_NOINFERIORS - This mailbox contains, and may not contain any
"children" (there are no mailboxes below this one). Calling
imap_createmailbox will not work on this mailbox.
LATT_NOSELECT - This is only a container,
not a mailbox - you cannot open it.
LATT_MARKED - This mailbox is marked. This means that it may
contain new messages since the last time it was checked. Not provided by all IMAP
servers.
LATT_UNMARKED - This mailbox is not marked, does not contain new
messages. If either MARKED or UNMARKED is
provided, you can assume the IMAP server supports this feature for this mailbox.
&reftitle.examples;
<function>imap_getmailboxes</function> example
$val) {
echo "($key) ";
echo imap_utf7_decode($val->name) . ",";
echo "'" . $val->delimiter . "',";
echo $val->attributes . "
\n";
}
} else {
echo "imap_getmailboxes failed: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
]]>
&reftitle.seealso;
imap_getsubscribed