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

�μ�