(PHP 4, PHP 5, PHP 7)
imap_listscan — 指定したテキストにマッチするメールボックスの一覧を返す
$imap_stream
, string $ref
, string $pattern
, string $content
) : array
content をテキストに持つメールボックスの名前を
配列で返します。
この関数は imap_listmailbox() に似ていますが、
メールボックス内に文字列 content が存在するか
どうかを調べる点が違います。
imap_streamimap_open() が返す IMAP ストリーム。
ref
通常、ref は
imap_open() で述べられているサーバー定義です。
pattern検索を開始するメールボックスの階層を指定します。
pattern の中で使用できる特別な文字として
'*' および '%' があります。
'*' は、すべてのメールボックスを意味します。
pattern に '*' を指定すると、
メールボックス階層全体のリストが得られます。
'%' は現在のレベルのみを意味します。
'%' を pattern に指定すると、
トップレベルのメールボックスのみを返します。UW_IMAPD の場合、
'~/mail/%' は
~/mail ディレクトリ内のすべてのメールボックスを返しますが、
そのディレクトリのサブフォルダにあるメールボックスは返しません。
content検索する文字列。
content をテキストに持つメールボックスの名前を
配列で返します。