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