imap_lsub
(PHP 4, PHP 5)
imap_lsub — 購読しているすべてのメールボックスの一覧を得る
説明
array imap_lsub
( resource
$imap_stream
, string $ref
, string $pattern
)購読しているすべてのメールボックスの配列を取得します。
パラメータ
-
imap_stream -
imap_open() が返す IMAP ストリーム。
-
ref -
通常、
refは imap_open() で述べられているサーバー定義です。 -
pattern -
検索を開始するメールボックスの階層を指定します。
patternの中で使用できる特別な文字として '*' および '%' があります。 '*' は、すべてのメールボックスを意味します。patternに '*' を指定すると、 メールボックス階層全体のリストが得られます。 '%' は現在のレベルのみを意味します。 '%' をpatternに指定すると、 トップレベルのメールボックスのみを返します。UW_IMAPD の場合、 '~/mail/%' は ~/mail ディレクトリ内のすべてのメールボックスを返しますが、 そのディレクトリのサブフォルダにあるメールボックスは返しません。
返り値
購読しているすべてのメールボックスの配列を返します。