(PHP 4, PHP 5)
imap_getmailboxes — Read the list of mailboxes, returning detailed information on each one
$imap_stream
, string $ref
, string $pattern
)Gets information on the mailboxes.
imap_stream
Un flux IMAP întors de imap_open().
ref
ref
should normally be just the server
specification as described in imap_open()
pattern
Specifică poziția în ierarhia cutiilor poștale de unde va începe căutarea.
Sunt două caractere speciale pe
care puteți să le transmiteți în cadrul pattern
:
'*' și '%'.
'*' înseamnă a returna toate cutiile poștale.
Dacă transmiteți pattern
ca '*',
veți obține o listă a întregii ierarhii a cutiilor poștale.
'%' înseamnă a întoarce doar nivelul curent.
'%' în calitate de pattern
va întoarce doar cutiile poștale de la nivelul superior;
'~/mail/%' pe UW_IMAPD
va întoarce toate cutiile poștale în directorul ~/mail,
dar nici una din submapele acstui director.
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.
Example #1 imap_getmailboxes() example
<?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);
?>