imap_listscan
指定したテキストにマッチするメールボックスの一覧を返す
説明
arrayfalse imap_listscan(
IMAP\Connection $imap
,
string $reference
,
string $pattern
,
string $content
)
この関数は imap_listmailbox に似ていますが、
メールボックス内に文字列 content
が存在するか
どうかを調べる点が違います。
パラメータ
-
imap
-
IMAP\Connection クラスのインスタンス。
-
reference
-
通常、reference
は
imap_open で述べられているサーバー定義です。
-
pattern
-
検索を開始するメールボックスの階層を指定します。
pattern
の中で使用できる特別な文字として
'*
' および '%
' があります。
'*
' は、すべてのメールボックスを意味します。
pattern
に '*
' を指定すると、
メールボックス階層全体のリストが得られます。
'%
' は現在のレベルのみを意味します。
'%
' を pattern
に指定すると、
トップレベルのメールボックスのみを返します。UW_IMAPD
の場合、
'~/mail/%
' は
~/mail ディレクトリ内のすべてのメールボックスを返しますが、
そのディレクトリのサブフォルダにあるメールボックスは返しません。
-
content
-
検索する文字列。
戻り値
content
をテキストに持つメールボックスの名前を配列で返します。
失敗した場合に false
を返します
参考
- imap_listmailbox
- imap_search