imap_list Read the list of mailboxes


imap_list

(PHP 4, PHP 5)

imap_listRead the list of mailboxes

说明

array imap_list ( resource $imap_stream , string $ref , string $pattern )

Read the list of mailboxes.

参数

imap_stream

imap_open() 返回的 IMAP 流。

ref

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

pattern

指定在邮箱层级的何处开始查找。

在组成 pattern 的字符中可使用两个特殊字符: '*' 和 '%'。 '*' 是指返回所有邮箱目录. 如果将'*'作为 pattern 参数时, 则会返回整个邮箱层级结构。 '%' 是指只返回当前级次。 '%' 作为 pattern 参数则只会返回顶层邮箱; '~/mail/%' 用于 UW_IMAPD 则会返回名为 ~/mail 的目录, 但不包含其子目录。

返回值

Returns an array containing the names of the mailboxes.

范例

Example #1 imap_list() example

<?php
$mbox 
imap_open("{imap.example.org}""username""password"OP_HALFOPEN)
      or die(
"can't connect: " imap_last_error());

$list imap_list($mbox"{imap.example.org}""*");
if (
is_array($list)) {
    foreach (
$list as $val) {
        echo 
imap_utf7_decode($val) . " ";
    }
} else {
    echo 
"imap_list failed: " imap_last_error() . " ";
}

imap_close($mbox);
?>

参见


«  imap_last_error
» imap_listmailbox
快速导航

Copyright © 2016 phpStudy | 皖ICP备18014864号-4