imap_list
(PHP 4, PHP 5, PHP 7)
imap_list — メールボックスのリストを読み込む
説明
imap_list
( resource $imap_stream
, string $ref
, string $pattern
) : array
メールボックスのリストを読み込みます。
パラメータ
imap_streamimap_open() が返す IMAP ストリーム。
ref通常、
refは imap_open() で述べられているサーバー定義です。警告
信頼できないデータをこのパラメータに渡すのであれば、 imap.enable_insecure_rsh を無効にしておかなければ危険です。
pattern検索を開始するメールボックスの階層を指定します。
patternの中で使用できる特別な文字として '*' および '%' があります。 '*' は、すべてのメールボックスを意味します。patternに '*' を指定すると、 メールボックス階層全体のリストが得られます。 '%' は現在のレベルのみを意味します。 '%' をpatternに指定すると、 トップレベルのメールボックスのみを返します。UW_IMAPDの場合、 '~/mail/%' は~/mailディレクトリ内のすべてのメールボックスを返しますが、 そのディレクトリのサブフォルダにあるメールボックスは返しません。
返り値
メールボックスの名前を含む配列を返します。 または失敗時に false を返します。
例
例1 imap_list() の例
<?php$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN) or die("接続できません: " . 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 が失敗しました: " . imap_last_error() . "\n";}imap_close($mbox);?>
