6.3.9 LIST コマンド
引数 (基本 - basic):
- 参照名
- 通配符を含む可能性のあるメールボックス名
引数 (拡張 - extended):
- 選択オプション (オプション - OPTIONAL)
- 参照名
- メールボックスパターン
- 返却オプション (オプション - OPTIONAL)
応答 (Responses): タグなし応答:LIST
結果 (Result):
- OK - list 完了
- NO - list 失敗:その参照またはメールボックス名をリストできません
- BAD - コマンド不明または引数が無効
LIST コマンドは、クライアントが利用可能なすべてのメールボックス名の完全なセットから、メールボックス名のサブセットを返します。名前属性、階層区切り文字、名前、および可能な拡張情報を含む、ゼロ個以上のタグなし LIST 応答が返されます。詳細については、LIST 応答の説明 (セクション 7.3.1) を参照してください。
LIST コマンドは、過度の遅延なく、データを迅速に返すべきです (返すべきです)。拡張 LIST コマンドは、元々 [RFC5258] で導入され、元の IMAP LIST コマンドを超える機能を提供します。
選択オプション (Selection Options) は、LIST 操作によって選択されるメールボックス名を制限するようサーバーに指示します。
返却オプション (Return Options) は、一致する各メールボックスに対してどの情報を返すかを制御します。
構文、ワイルドカード、選択オプション、返却オプションの詳細な仕様については、完全な RFC テキストを参照してください。