imap_listscan

(PHP 4, PHP 5)

imap_listscan — 指定したテキストにマッチするメールボックスの一覧を返す

説明

array imap_listscan ( resource $imap_stream , string $ref , string $pattern , string $content )

content をテキストに持つメールボックスの名前を配列で返します。

この関数は imap_listmailbox() に似ていますが、メールボックス内に文字列 content が存在するかどうかを調べる点が違います。

パラメータ

imap_stream

imap_open() が返す IMAP ストリーム。

ref

通常、ref は imap_open() で述べられているサーバ定義です。

pattern

検索を開始するメールボックスの階層を指定します。

pattern の中で使用できる特別な文字として '*' および '%' があります。 '*' は、すべてのメールボックスを意味します。 pattern に '*' を指定すると、メールボックス階層全体のリストが得られます。 '%' は現在のレベルのみを意味します。 '%' を pattern に指定すると、トップレベルのメールボックスのみを返します。UW_IMAPD の場合、 '~/mail/%' は ~/mail ディレクトリ内のすべてのメールボックスを返しますが、そのディレクトリのサブフォルダにあるメールボックスは返しません。

content