imap_getmailboxes

(PHP 4, PHP 5, PHP 7)

imap_getmailboxes — Read the list of mailboxes, returning detailed information on each one

说锟斤拷

imap_getmailboxes ( resource $imap_stream , string $ref , string $pattern ) : array

Gets information on the mailboxes.

锟斤拷锟斤拷

imap_stream

锟斤拷 imap_open() 锟斤拷锟截碉拷 IMAP 锟斤拷锟斤拷

ref

ref should normally be just the server specification as described in imap_open()

Warning

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

pattern

指锟斤拷锟斤拷锟斤拷锟斤拷慵讹拷暮未锟斤拷锟绞硷拷锟斤拷摇锟�

锟斤拷锟斤拷锟� pattern 锟斤拷锟街凤拷锟叫匡拷使锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷锟街凤拷锟斤拷 '*' 锟斤拷 '%'锟斤拷 '*' 锟斤拷指锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷目录. 锟斤拷锟斤拷锟� '*' 锟斤拷为 pattern 锟斤拷锟斤拷时, 锟斤拷岱碉拷锟斤拷锟斤拷锟斤拷锟斤拷锟姐级锟结构锟斤拷 '%' 锟斤拷指只锟斤拷锟截碉拷前锟斤拷锟轿★拷 '%' 锟斤拷为 pattern 锟斤拷锟斤拷锟斤拷只锟结返锟截讹拷锟斤拷锟斤拷锟戒； '~/mail/%' 锟斤拷锟斤拷 UW_IMAPD 锟斤拷岱碉拷锟斤拷锟轿� ~/mail 锟斤拷目录, 锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷锟斤拷目录锟斤拷

锟斤拷锟斤拷值

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 not 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.

  • LATT_REFERRAL - This container has a referral to a remote mailbox.

  • LATT_HASCHILDREN - This mailbox has selectable inferiors.

  • LATT_HASNOCHILDREN - This mailbox has no selectable inferiors.

锟斤拷锟斤拷

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);
?>

锟轿硷拷