PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    imap_lsub

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

    imap_lsub — 購読しているすべてのメールボックスの一覧を得る

    説明

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

    購読しているすべてのメールボックスの配列を取得します。

    パラメータ

    imap

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

    reference

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

    警告

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

    pattern

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

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

    戻り値

    購読しているすべてのメールボックスの配列を返します。 失敗した場合に false を返します

    変更履歴

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

    参考

    • imap_list() - メールボックスのリストを読み込む
    • imap_getmailboxes() - メールボックスのリストを読み込み、各ボックスに関する詳細な情報を返す

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top