(PHP 4, PHP 5, PHP 7)
imap_getsubscribed — 購読中の全メールボックスの一覧を取得する
$imap_stream
, string $ref
, string $pattern
) : array購読中のメールボックスの情報を取得します。
imap_getmailboxes() と同じ動作をしますが、 ユーザーが購読しているメールボックスのみを返すという点が異なります。
imap_streamimap_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 でのみ使用されます。