imap_getsubscribed
(PHP 4, PHP 5)
imap_getsubscribed — 購読中の全メールボックスの一覧を取得する
説明
array imap_getsubscribed
( resource $imap_stream
, string $ref
, string $pattern
)
購読中のメールボックスの情報を取得します。
imap_getmailboxes() と同じ動作をしますが、 ユーザが購読しているメールボックスのみを返すという点が異なります。
パラメータ
- imap_stream
-
imap_open() が返す IMAP ストリーム。
- ref
-
ref は、通常は imap_open() で指定したサーバ情報です。
- pattern
-
検索を開始するメールボックスの階層を指定します。
pattern の中で使用できる特別な文字として '*' および '%' があります。'*' は、全てのメールボックスを意味します。 pattern に '*' を指定した場合、メールボックス 階層全体のリストが得られます。'%' は現在のレベルのみを意味します。 '%' を pattern に指定した場合、 トップレベルのメールボックスのみが返されます。UW_IMAPD を使用した場合、 '~/mail/%' は ~/mail ディレクトリの全てのメールボックスを返しますが、 そのディレクトリのサブフォルダーにあるメールボックスは返しません。
返り値
メールボックス情報を有するオブジェクトの配列を返します。各オブジェクトには、 メールボックスの完全な名前である name 、 このメールボックスの階層の区切りを示す属性 delimiter 、 そして attributes が存在します。 attributes はビットマスクであり、 次のものについて調べることができます。
- LATT_NOINFERIORS - このメールボックスには 「子供」はいません（このボックスの中にメールボックスはありません）。
- LATT_NOSELECT - 単なるコンテナであり、 メールボックスではありません - これをオープンすることはできません。
- LATT_MARKED - このメールボックスにはマークが つけられています。UW-IMAPD でのみ使用されます。
- LATT_UNMARKED - このメールボックスにはマークが つけられていません。UW-IMAPD でのみ使用されます。