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