imap_listscan

(PHP 4, PHP 5, PHP 7, PHP 8)

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

説明

imap_listscan(
    IMAP\Connection $imap,
    string $reference,
    string $pattern,
    string $content
): array|false

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

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

パラメータ

imap

IMAP\Connection クラスのインスタンス。

reference

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

警告

信頼できないデータをこのパラメータに渡すのであれば、 imap.enable_insecure_rsh を無効にしておかなければ危険です。

pattern

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

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

content

検索する文字列。

戻り値

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

変更履歴

バージョン 説明
8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース が期待されていました。

参考

関連キーワード:  メールボックス, テキスト, マッチ, 指定, 一覧, content, pattern, reference, 検索, 配列