PHP 8.1.0 RC 2 available for testing

imap_lsub

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

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

説明

imap_lsub(resource $imap, string $reference, string $pattern): array|false

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

パラメータ

imap

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

reference

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

警告

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

pattern

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

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

返り値

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

参考

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

add a note add a note

User Contributed Notes

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