メールボックス情報を有するオブジェクトの配列を返します。各オブジェクトは、
メールボックスの完全な名前である
name
、 このメールボックスの階層の区切りを示す属性
delimiter
、
attributes
を有しています。
attributes
はビットマスクであり、次のものについて 調べることができます。
LATT_NOINFERIORS - このメールボックスは "子" を有しません
(このボックスの中にメールボックスはありません。)
LATT_NOSELECT - 単なるコンテナであり、メールボックスではありません。
これをオープンすることはできません。
LATT_MARKED - このメールボックスには印が付けられています。 UW-IMAPD
でのみ使用されます。
LATT_UNMARKED - このメールボックスはマークされていません。 UW-IMAPD
でのみ必要です。
通常、
ref
は、{imap_server:imap_port} 形式の IMAP サーバーとする必要があります。 また、
pattern
により検索を開始するメールボックスの 階層を指定します。 全てのメールボックスを検索したい場合には、
pattern
に'*'を指定して下さい。
pattern
の中で使用できる特別な文字として '*' および '%' があります。'*' は、全てのメールボックスを意味しま す。
pattern
に '*' を指定した場合、メール ボックス階層全体のリストが得られます。'%' は現在のレベルのみを意 味します。'%' を
pattern
に指定した場合、トッ プレベルのメールボックスのみが返されます。UW_IMAPD を使用した場 合、'~/mail/%' は
~/mail ディレクトリの全てのメールボックスを返し ますが、そのディレクトリのサブフォルダーにあるメールボックスは返
しません。
imap_getsubscribed()
も参照下さい。