Php/docs/function.imap-list

来自菜鸟教程
跳转至:导航、​搜索

imap_list

(PHP 4, PHP 5, PHP 7)

imap_listRead the list of mailboxes


说明

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

Read the list of 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 containing the names of the mailboxes or false in case of failure.


范例

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) . "\n";    }} else {    echo "imap_list failed: " . imap_last_error() . "\n";}imap_close($mbox);?>

参见