無料CGI、PHPサイト(確認画面付きメールフォーム・メーリングリスト・メルマガ設置、逆アクセスランキング、画像カウンター等)PHPマニュアル by k-sky

imap_lsub

(PHP 4, PHP 5)

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

説明

array imap_lsub ( resource $imap_stream , string $ref , string $pattern )

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

パラメータ

imap_stream

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

ref

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

pattern

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

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

返り値

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