[要約] RFC 4731は、IMAP4のSEARCHコマンドの拡張であり、返される情報の種類を制御するためのものです。このRFCの目的は、IMAP4クライアントが必要な情報のみを取得できるようにすることです。
Network Working Group A. Melnikov
Request for Comments: 4731 Isode Ltd
Category: Standards Track D. Cridland
Inventure Systems Ltd
November 2006
IMAP4 Extension to SEARCH Command for Controlling What Kind of Information Is Returned
どの種類の情報が返されるかを制御するための検索コマンドへのIMAP4拡張
Status of This Memo
本文書の位置付け
This document specifies an Internet standards track protocol for the Internet community, and requests discussion and suggestions for improvements. Please refer to the current edition of the "Internet Official Protocol Standards" (STD 1) for the standardization state and status of this protocol. Distribution of this memo is unlimited.
このドキュメントは、インターネットコミュニティのインターネット標準トラックプロトコルを指定し、改善のための議論と提案を要求します。このプロトコルの標準化状態とステータスについては、「インターネット公式プロトコル標準」（STD 1）の現在のエディションを参照してください。このメモの配布は無制限です。
Copyright Notice
著作権表示
Copyright (C) The IETF Trust (2006).
Copyright（c）The IETF Trust（2006）。
Abstract
概要
This document extends IMAP (RFC 3501) SEARCH and UID SEARCH commands with several result options, which can control what kind of information is returned. The following result options are defined: minimal value, maximal value, all found messages, and number of found messages.
このドキュメントは、いくつかの結果オプションを備えたIMAP（RFC 3501）検索およびUID検索コマンドを拡張します。これにより、どのような情報が返されるかを制御できます。次の結果オプションが定義されています：最小値、最大値、すべての表示メッセージ、および発見されたメッセージの数。
Table of Contents
目次
1. Introduction ....................................................2
2. Conventions Used in This Document ...............................2
3. IMAP Protocol Changes ...........................................2
3.1. New SEARCH/UID SEARCH Result Options .......................2
3.2. Interaction with CONDSTORE extension .......................4
4. Formal Syntax ...................................................5
5. Security Considerations .........................................6
6. IANA Considerations .............................................6
7. Normative References ............................................6
8. Acknowledgments .................................................6
[IMAPABNF] extended SEARCH and UID SEARCH commands with result specifiers (also known as result options), which can control what kind of information is returned.
[IMAPABNF]拡張検索およびUID検索コマンドは、結果仕様（結果オプションとも呼ばれます）を使用して、どのような種類の情報が返されるかを制御できます。
A server advertising the ESEARCH capability supports the following result options: minimal value, maximal value, all found messages, and number of found messages. These result options allow clients to get SEARCH results in more convenient forms, while also saving bandwidth required to transport the results, for example, by finding the first unseen message or returning the number of unseen or deleted messages. Also, when a single MIN or a single MAX result option is specified, servers can optimize execution of SEARCHes.
ESEarch機能を宣伝するサーバーは、次の結果オプションをサポートしています：最小値、最大値、見つかったすべてのメッセージ、および発見されたメッセージの数。これらの結果オプションにより、クライアントは検索結果をより便利な形式で取得することができ、例えば、最初の目に見えないメッセージを見つけたり、目に見えないメッセージまたは削除されたメッセージの数を返すことにより、結果の輸送に必要な帯域幅を保存します。また、1分または単一の最大結果オプションが指定されている場合、サーバーは検索の実行を最適化できます。
In examples, "C:" and "S:" indicate lines sent by the client and server, respectively.
例では、「C：」と「S：」は、それぞれクライアントとサーバーから送信された行を示します。
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [KEYWORDS].
「必須」、「そうしない」、「必須」、「必要」、「「しない」、「そうでない」、「そうではない」、「そうでない」、「推奨」、「5月」、および「オプション」は、RFC 2119 [キーワード]に記載されているとおりに解釈されます。
The SEARCH/UID SEARCH commands are extended to allow for the following result options:
検索/UID検索コマンドは、次の結果オプションを可能にするために拡張されます。
MIN Return the lowest message number/UID that satisfies the SEARCH criteria.
min検索基準を満たす最低メッセージ番号/UIDを返します。
If the SEARCH results in no matches, the server MUST NOT include the MIN result option in the ESEARCH response; however, it still MUST send the ESEARCH response.
検索が一致しない場合、サーバーはESearch応答に最小結果オプションを含めてはなりません。ただし、ESEarchの応答を送信する必要があります。
MAX Return the highest message number/UID that satisfies the SEARCH criteria.
MAXは、検索条件を満たす最高のメッセージ番号/UIDを返します。
If the SEARCH results in no matches, the server MUST NOT include the MAX result option in the ESEARCH response; however, it still MUST send the ESEARCH response.
検索が一致しない場合、サーバーはEsearch応答に最大結果オプションを含めてはなりません。ただし、ESEarchの応答を送信する必要があります。
ALL Return all message numbers/UIDs that satisfy the SEARCH criteria. Unlike regular (unextended) SEARCH, the messages are always returned using the sequence-set syntax. A sequence-set representation may be more compact and can be used as is in a subsequent command that accepts sequence-set. Note, the client MUST NOT assume that messages/UIDs will be listed in any particular order.
すべてのメッセージ番号/uidsをすべて返し、検索条件を満たします。通常の（拡張されていない）検索とは異なり、メッセージは常にシーケンスセットの構文を使用して返されます。シーケンスセット表現はよりコンパクトであり、シーケンスセットを受け入れる後続のコマンドのように使用できます。注意、クライアントは、メッセージ/UIDが特定の順序でリストされると想定してはなりません。
If the SEARCH results in no matches, the server MUST NOT include the ALL result option in the ESEARCH response; however, it still MUST send the ESEARCH response.
検索が一致しない場合、サーバーはESEarch応答のすべての結果オプションを含めてはなりません。ただし、ESEarchの応答を送信する必要があります。
COUNT Return number of the messages that satisfy the SEARCH criteria. This result option MUST always be included in the ESEARCH response.
検索基準を満たすメッセージの返品番号をカウントします。この結果オプションは、常にESEarch応答に含める必要があります。
If one or more result options described above are specified, the extended SEARCH command MUST return a single ESEARCH response [IMAPABNF], instead of the SEARCH response.
上記の1つ以上の結果オプションが指定されている場合、拡張検索コマンドは、検索応答の代わりに、単一のESEarch応答[IMAPABNF]を返す必要があります。
An extended UID SEARCH command MUST cause an ESEARCH response with the UID indicator present.
拡張されたUID検索コマンドは、UIDインジケータが存在することでESEarch応答を引き起こす必要があります。
Note that future extensions to this document can allow servers to return multiple ESEARCH responses for a single extended SEARCH command. These extensions will have to describe how results from multiple ESEARCH responses are to be amalgamated.
このドキュメントの将来の拡張機能により、サーバーは単一の拡張検索コマンドの複数のESEART応答を返すことができることに注意してください。これらの拡張機能は、複数のESEarch応答からの結果を融合する方法を説明する必要があります。
If the list of result options is empty, that requests the server to return an ESEARCH response instead of the SEARCH response. This is equivalent to "(ALL)".
結果オプションのリストが空の場合、サーバーに検索応答の代わりにeSearch応答を返すように要求します。これは「（すべて）」に相当します。
Example: C: A282 SEARCH RETURN (MIN COUNT) FLAGGED
SINCE 1-Feb-1994 NOT FROM "Smith"
S: * ESEARCH (TAG "A282") MIN 2 COUNT 3
S: A282 OK SEARCH completed
Example: C: A283 SEARCH RETURN () FLAGGED
SINCE 1-Feb-1994 NOT FROM "Smith"
S: * ESEARCH (TAG "A283") ALL 2,10:11
S: A283 OK SEARCH completed
The following example demonstrates finding the first unseen message as returned in the UNSEEN response code on a successful SELECT command:
次の例は、成功した選択コマンドの目に見えない応答コードで返された最初の目に見えないメッセージを見つけることを示しています。
Example: C: A284 SEARCH RETURN (MIN) UNSEEN
S: * ESEARCH (TAG "A284") MIN 4
S: A284 OK SEARCH completed
The following example demonstrates that if the ESEARCH UID indicator is present, all data in the ESEARCH response is referring to UIDs; for example, the MIN result specifier will be followed by a UID.
次の例は、ESEarch UIDインジケーターが存在する場合、ESEarch ResponseのすべてのデータがUIDSを参照していることを示しています。たとえば、MIN結果仕様の後にUIDが続きます。
Example: C: A285 UID SEARCH RETURN (MIN MAX) 1:5000
S: * ESEARCH (TAG "A285") UID MIN 7 MAX 3800
S: A285 OK SEARCH completed
The following example demonstrates returning the number of deleted messages:
次の例は、削除されたメッセージの数を返すことを示しています。
Example: C: A286 SEARCH RETURN (COUNT) DELETED
S: * ESEARCH (TAG "A286") COUNT 15
S: A286 OK SEARCH completed
When the server supports both the ESEARCH and the CONDSTORE [CONDSTORE] extension, and the client requests one or more result option described in section 3.1 together with the MODSEQ search criterion in the same SEARCH/UID SEARCH command, then the server MUST return the ESEARCH response containing the MODSEQ result option (described in the following paragraph) instead of the extended SEARCH response described in section 3.5 of [CONDSTORE].
サーバーがesearchとcondstore [condstore]拡張機能の両方をサポートし、クライアントがセクション3.1で説明されている1つ以上の結果オプションを同じ検索/UID検索コマンドのmodSeq検索条件を要求する場合、サーバーはeSearchを返す必要があります[condstore]のセクション3.5で説明されている拡張検索応答の代わりに、modSeq結果オプション（次の段落で説明）を含む応答。
If the SEARCH/UID SEARCH command contained a single MIN or MAX result option, the MODSEQ result option contains the mod-sequence for the found message. If the SEARCH/UID SEARCH command contained both MIN and MAX result options and no ALL/COUNT option, the MODSEQ result option contains the highest mod-sequence for the two returned messages. Otherwise the MODSEQ result option contains the highest mod-sequence for all messages being returned.
検索/UID検索コマンドに1分または最大結果オプションが含まれている場合、MODSEQ結果オプションには、見つかったメッセージのMODシーケンスが含まれます。検索/UID検索コマンドにMINとMAXの結果オプションの両方が含まれており、All/Countオプションがない場合、ModSeq結果オプションには、2つの返されたメッセージの最高のmodシーケンスが含まれます。それ以外の場合、MODSEQ結果オプションには、返されるすべてのメッセージの最高のMODシーケンスが含まれています。
Example: The following example demonstrates how Example 15 from [CONDSTORE] would look in the presence of one or more result option:
例：次の例は、[condstore]の例15が1つ以上の結果オプションが存在する場合にどのように見えるかを示しています。
C: a1 SEARCH RETURN (MIN) MODSEQ "/flags/\\draft"
all 620162338
S: * ESEARCH (TAG "a1") MIN 2 MODSEQ 917162488
S: a1 OK Search complete
C: a2 SEARCH RETURN (MAX) MODSEQ "/flags/\\draft"
all 620162338
S: * ESEARCH (TAG "a2") MAX 23 MODSEQ 907162321
S: a2 OK Search complete
C: a3 SEARCH RETURN (MIN MAX) MODSEQ "/flags/\\draft"
all 620162338
S: * ESEARCH (TAG "a3") MIN 2 MAX 23 MODSEQ 917162488
S: a3 OK Search complete
C: a4 SEARCH RETURN (MIN COUNT) MODSEQ "/flags/\\draft"
all 620162338
S: * ESEARCH (TAG "a4") MIN 2 COUNT 10 MODSEQ 917162500
S: a4 OK Search complete
The following syntax specification uses the Augmented Backus-Naur Form (ABNF) notation as specified in [ABNF].
次の構文仕様では、[ABNF]で指定されているように、拡張されたBackus-Naurフォーム（ABNF）表記を使用します。
Non-terminals referenced but not defined below are as defined by [IMAP4], [CONDSTORE], or [IMAPABNF].
参照されていないが、以下に定義されていない非末端は、[IMAP4]、[condstore]、または[imapabnf]によって定義されています。
Except as noted otherwise, all alphabetic characters are case-insensitive. The use of upper or lowercase characters to define token strings is for editorial clarity only. Implementations MUST accept these strings in a case-insensitive fashion.
それ以外の場合は、言及されている場合を除き、すべてのアルファベット文字はケース非感受性です。トークン文字列を定義するために上位または小文字の文字を使用することは、編集の明確性のみを目的としています。実装は、これらの文字列をケースに依存しない方法で受け入れる必要があります。
capability =/ "ESEARCH"
search-return-data = "MIN" SP nz-number /
"MAX" SP nz-number /
"ALL" SP sequence-set /
"COUNT" SP number
;; conforms to the generic
;; search-return-data syntax defined
;; in [IMAPABNF]
search-return-opt = "MIN" / "MAX" / "ALL" / "COUNT"
;; conforms to generic search-return-opt
;; syntax defined in [IMAPABNF]
When the CONDSTORE [CONDSTORE] IMAP extension is also supported, the ABNF is updated as follows:
Condstore [Condstore] IMAP拡張もサポートされると、ABNFは次のように更新されます。
search-return-data =/ "MODSEQ" SP mod-sequence-value
;; mod-sequence-value is defined
;; in [CONDSTORE]
In the general case, the IMAP SEARCH/UID SEARCH commands can be CPU and/or IO intensive, and are seen by some as a potential attack point for denial of service attacks, so some sites/implementations even disable them entirely. This is quite unfortunate, as SEARCH command is one of the best examples demonstrating IMAP advantage over POP3.
一般的なケースでは、IMAP検索/UID検索コマンドはCPUおよび/またはIO集中的であり、一部の人々はサービス拒否攻撃の潜在的な攻撃ポイントと見なされるため、一部のサイト/実装はそれらを完全に無効にします。検索コマンドは、POP3よりもIMAPの利点を示す最良の例の1つであるため、これは非常に残念です。
The ALL and COUNT return options don't change how SEARCH is working internally; they only change how information about found messages is returned. MIN and MAX SEARCH result options described in this document can lighten the load on IMAP servers that choose to optimize SEARCHes containing only one or both of them.
すべておよびカウントリターンオプションは、検索が内部的に機能する方法を変更しません。彼らは、見つかったメッセージに関する情報がどのように返されるかを変更するだけです。このドキュメントで説明されているMINおよびMAX検索結果オプションは、1つまたは両方を含む検索を最適化することを選択するIMAPサーバーの負荷を明るくすることができます。
It is believed that this extension doesn't raise any additional security concerns not already discussed in [IMAP4].
この拡張は、[IMAP4]でまだ議論されていない追加のセキュリティ上の懸念を提起しないと考えられています。
IMAP4 capabilities are registered by publishing a standards track RFC or an IESG-approved experimental RFC. The registry is currently located at <http://www.iana.org/assignments/imap4-capabilities>.
IMAP4機能は、RFCまたはIESGが承認した実験RFCを公開することにより登録されます。レジストリは現在、<http://www.iana.org/assignments/imap4-capability>にあります。
This document defines the ESEARCH IMAP capability, which IANA added to the registry.
このドキュメントでは、IANAがレジストリに追加したESearch IMAP機能を定義します。
[KEYWORDS] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
[キーワード] Bradner、S。、「要件レベルを示すためにRFCで使用するためのキーワード」、BCP 14、RFC 2119、1997年3月。
[IMAP4] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1", RFC 3501, March 2003.
[IMAP4] Crispin、M。、「インターネットメッセージアクセスプロトコル -バージョン4REV1」、RFC 3501、2003年3月。
[ABNF] Crocker, D. (Ed.) and P. Overell , "Augmented BNF for Syntax Specifications: ABNF", RFC 4234, October 2005.
[ABNF] Crocker、D。（ed。）およびP. Overell、「構文仕様のためのBNFの増強：ABNF」、RFC 4234、2005年10月。
[IMAPABNF] Melnikov, A. and C. Daboo, "Collected Extensions to IMAP4 ABNF", RFC 4466, April 2006..
[Imapabnf] Melnikov、A。and C. daboo、「拡張機能をIMAP4 ABNFに収集しました」、RFC 4466、2006年4月。
[CONDSTORE] Melnikov, A. and S. Hole, "IMAP Extension for Conditional STORE", RFC 4551, June 2006.
[Condstore] Melnikov、A。and S. Hole、「条件付きストアのIMAP拡張」、RFC 4551、2006年6月。
Thanks to Michael Wener, Arnt Gulbrandsen, Cyrus Daboo, Mark Crispin, and Pete Maclean for comments and corrections.
Michael Wener、Arnt Gulbrandsen、Cyrus Daboo、Mark Crispin、Pete Macleanにコメントと修正をありがとう。
Authors' Addresses
著者のアドレス
Alexey Melnikov Isode Limited 5 Castle Business Village 36 Station Road Hampton, Middlesex, TW12 2BX UK
Alexey Melnikov Isode Limited 5 Castle Business Village 36 Station Road Hampton、ミドルセックス、TW12 2BX UK
EMail: Alexey.Melnikov@isode.com
Dave A. Cridland Inventure Systems Limited
Dave A. Cridland Inventure Systems Limited
EMail: dave.cridland@inventuresystems.co.uk
URL: http://invsys.co.uk/dave/
Full Copyright Statement
完全な著作権声明
Copyright (C) The IETF Trust (2006).
Copyright（c）The IETF Trust（2006）。
This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.
This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST, AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
このドキュメントとここに含まれる情報は、「現状」に基づいて提供され、貢献者、彼/彼女が代表する組織（もしあれば）、インターネット協会、IETFトラスト、インターネットエンジニアリングタスクフォースは免責明示的または暗示されたすべての保証。ここでの情報の使用が、商品性または特定の目的に対する適合性の権利または黙示的な保証を侵害しないという保証を含むがこれらに限定されない。
Intellectual Property
知的財産
The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.
IETFは、知的財産権またはその他の権利の有効性または範囲に関して、この文書に記載されている技術の実装または使用、またはそのような権利に基づくライセンスがどの程度であるかについての使用に関連すると主張する可能性があるという立場はありません。利用可能になります。また、そのような権利を特定するために独立した努力をしたことも表明していません。RFCドキュメントの権利に関する手順に関する情報は、BCP 78およびBCP 79に記載されています。
Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.
IETF事務局に行われたIPR開示のコピーと、利用可能にするライセンスの保証、またはこの仕様の実装者またはユーザーによるそのような独自の権利の使用のための一般的なライセンスまたは許可を取得するための試みの結果を取得できます。http://www.ietf.org/iprのIETFオンラインIPRリポジトリから。
The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.
IETFは、関心のある当事者に、著作権、特許、または特許出願、またはこの基準を実装するために必要なテクノロジーをカバーする可能性のあるその他の独自の権利を注意深く招待します。ietf-ipr@ietf.orgのIETFへの情報をお問い合わせください。
Acknowledgement
謝辞
Funding for the RFC Editor function is currently provided by the Internet Society.
RFCエディター機能の資金は現在、インターネット協会によって提供されています。