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