array imap_getmailboxes(int imap_stream, string ref, string pat);メールボックス情報を有するオブジェクトの配列を返します。各オブジェクトは、 メールボックスの完全な名前である 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 ディレクトリの全ての メールボックスを返しますが、そのディレクトリのサブフォルダーにある メールボックスは返しません。