imap_getmailboxes
imap_getmailboxes
Read the list of mailboxes, returning detailed information on each one
**imap_getmailboxes** IMAP\Connection $imap string $reference string $pattern
Gets information on the mailboxes.
reference
should normally be just the server
specification as described in
reference``imap_open
pattern
Returns an array of objects containing mailbox information. Each object has the attributes , specifying the full name of the mailbox; , which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and . is a bitmask that can be tested against:
The function returns false on failure.
name``delimiter``attributes``Attributes- - This mailbox not contains, and may not contain any "children" (there are no mailboxes below this one). Calling will not work on this mailbox. LATT_NOINFERIORS``imap_createmailbox
-
- This is only a container, not a mailbox - you cannot open it.
LATT_NOSELECT
- This is only a container, not a mailbox - you cannot open it.
-
- 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_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.
-
- This mailbox is not marked, does not contain new messages. If either or is provided, you can assume the IMAP server supports this feature for this mailbox.
LATT_UNMARKED``MARKED``UNMARKED
- This mailbox is not marked, does not contain new messages. If either or is provided, you can assume the IMAP server supports this feature for this mailbox.
-
- This container has a referral to a remote mailbox.
LATT_REFERRAL
- This container has a referral to a remote mailbox.
-
- This mailbox has selectable inferiors.
LATT_HASCHILDREN
- This mailbox has selectable inferiors.
-
- This mailbox has no selectable inferiors.
LATT_HASNOCHILDREN
Voorbeeld: example
- This mailbox has no selectable inferiors.
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("can't connect: " . 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 failed: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>
imap_getsubscribed