idnits 2.17.1 draft-melnikov-condstore-sort-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 14. -- Found old boilerplate from RFC 3978, Section 5.5 on line 256. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 228. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 235. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 241. ** This document has an original RFC 3978 Section 5.4 Copyright Line, instead of the newer IETF Trust Copyright according to RFC 4748. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard == The page length should not exceed 58 lines per page, but there was 1 longer page, the longest (page 1) being 290 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There are 33 instances of too long lines in the document, the longest one being 9 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (December 2005) is 6706 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'IMAPABNF' is mentioned on line 141, but not defined ** Obsolete normative reference: RFC 4234 (ref. 'ABNF') (Obsoleted by RFC 5234) ** Obsolete normative reference: RFC 3501 (ref. 'IMAP4') (Obsoleted by RFC 9051) -- Possible downref: Non-RFC (?) normative reference: ref. 'SORT' -- Possible downref: Non-RFC (?) normative reference: ref. 'CONDSTORE' Summary: 6 errors (**), 0 flaws (~~), 4 warnings (==), 10 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Draft: SORT extension to IMAP Conditional STORE A. Melnikov 2 Document: draft-melnikov-condstore-sort-00.txt Isode Ltd. 3 Expires: June 2006 S. Hole 4 ACI WorldWide/MessagingDirect 5 December 2005 7 SORT extension to IMAP Conditional STORE 9 Status of this Memo 11 By submitting this Internet-Draft, each author represents that any 12 applicable patent or other IPR claims of which he or she is aware 13 have been or will be disclosed, and any of which he or she becomes 14 aware will be disclosed, in accordance with Section 6 of BCP 79. 16 Internet-Drafts are working documents of the Internet Engineering 17 Task Force (IETF), its areas, and its working groups. Note that 18 other groups may also distribute working documents as Internet- 19 Drafts. 21 Internet-Drafts are draft documents valid for a maximum of six months 22 and may be updated, replaced, or obsoleted by other documents at any 23 time. It is inappropriate to use Internet-Drafts as reference 24 material or to cite them other than as "work in progress". 26 The list of current Internet-Drafts can be accessed at 27 http://www.ietf.org/ietf/1id-abstracts.txt 29 The list of Internet-Draft Shadow Directories can be accessed at 30 http://www.ietf.org/shadow.html. 32 Copyright Notice 34 Copyright (C) The Internet Society (2005). 36 Abstract 38 This document specifies SORT extension to the IMAP Conditional STORE 39 extension, which allows a client to request a sorted list of metadata 40 (flag) changes. 42 Table of Contents 44 1 Conventions Used in This Document ......................... X 45 2 Introduction and Overview ................................. X 46 3 IMAP Protocol Changes ..................................... X 47 3.1 MODSEQ Sort Criterion .................................... X 48 3.2 Modified SEARCH and SORT untagged responses .............. X 49 4 Formal Syntax ............................................. X 50 5 Security Considerations ................................... X 51 6 References ................................................ X 52 6.1 Normative References ..................................... X 53 7 IANA Considerations ....................................... X 54 9 Author's Addresses ........................................ X 55 10 Intellectual Property Rights .............................. X 57 1. Conventions Used in This Document 59 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 60 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 61 document are to be interpreted as described in RFC 2119 [KEYWORDS]. 63 In examples, lines beginning with "S:" are sent by the IMAP server, and 64 lines beginning with "C:" are sent by the client. Line breaks may appear 65 in example commands solely for editorial clarity; when present in 66 the actual message they are represented by "CRLF". 68 Formal syntax is defined using ABNF [ABNF]. 70 The terms "metadata" (or "metadata item") and "CONDSTORE enabling command" 71 are defined in [CONDSTORE]. 73 2. Introduction and Overview 75 This document defines a new SORT extension with a capability name 76 "SORT=MODSEQ". This extension is upwards compatible with the SORT extension 77 defined in [SORT]. Server implementations that support both the CONDSTORE and 78 SORT extensions SHOULD also support the SORT=MODSEQ extension. The 79 SORT=MODSEQ extension makes the following additions to the SORT extension: 81 a) extends syntax of untagged SORT responses to include mod-sequence 82 (see section 3.2) 84 b) adds a new MODSEQ sort criterion (see section 3.1) 86 This document extends the list of "CONDSTORE enabling commands" defined in 87 [CONDSTORE] to include the SORT command that includes the MODSEQ message data 88 item. 90 The rest of this document describes the protocol changes more rigorously. 92 3. IMAP Protocol Changes 94 3.1. MODSEQ Sort Criterion 96 If client specifies a MODSEQ search (as per section 3.4) or sort 97 criterion in the SORT command and the server returns a non-empty 98 SORT result, the server MUST also append (to the end of the untagged 99 SORT response) the highest mod-sequence for all messages being returned. 100 See also section 3.6. 102 Example (MODSEQ sort criterion): 104 C: A282 SORT (SUBJECT MODSEQ) UTF-8 SINCE 1-Feb-2001 105 S: * SORT 2 81 83 84 82 882 (MODSEQ 117) 106 S: A282 OK SORT completed 108 Example (MODSEQ search criterion): 110 C: A283 SORT (SUBJECT REVERSE DATE) UTF-8 MODSEQ 21 111 S: * SORT 6 3 4 5 2 (MODSEQ 125) 112 S: A283 OK SORT completed 114 Example (MODSEQ search criterion and MODSEQ SORT criterion, 115 but no messages matching the search criteria): 117 C: A284 SORT (MODSEQ) KOI8-R OR NOT MODSEQ 20010320162338 118 SUBJECT "Privet" 119 S: * SORT 120 S: A284 OK Sort complete, nothing found 122 3.2. Modified SORT untagged response 124 Data: zero or more numbers 125 mod-sequence value (omitted if no match) 127 This document extends syntax of the untagged SORT response 128 to include the highest mod-sequence for all messages being returned. 130 If client specifies a MODSEQ search [CONDSTORE] or sort criterion in a 131 SORT (or UID SORT) command and the server returns a non-empty SORT result, 132 the server MUST also append (to the end of the untagged SORT response) 133 the highest mod-sequence for all messages being returned. See section 134 3.1 for examples. 136 4. Formal Syntax 138 The following syntax specification uses the Augmented Backus-Naur 139 Form (ABNF) [ABNF] notation. Elements not defined here can be found in 140 the formal syntax of the ABNF [ABNF], IMAP [IMAP4], [CONDSTORE] 141 <<, and IMAP ABNF extensions [IMAPABNF] specifications>>. 143 Except as noted otherwise, all alphabetic characters are case- 144 insensitive. The use of upper or lower case characters to define token 145 strings is for editorial clarity only. Implementations MUST accept 146 these strings in a case-insensitive fashion. 148 capability =/ "SORT=MODSEQ" 150 search-key =/ search-modsequence 151 ;; modifies original IMAP4 search-key 152 ;; 153 ;; This change applies to all command referencing 154 ;; this non-terminal, in particular SORT. 155 <> 158 sort-key =/ "MODSEQ" 160 mailbox-data =/ "SORT" [1*(SP nz-number) SP search-sort-mod-seq] 162 5. Security Considerations 164 It is believed that this extension doesn't raise any new security concerns 165 that are not already discussed in [IMAP4], [CONDSTORE] or [SORT]. 167 6. References 169 6.1. Normative References 171 [KEYWORDS] Bradner, "Key words for use in RFCs to Indicate 172 Requirement Levels", RFC 2119, Harvard University, March 1997. 174 [ABNF] Crocker, Overell, "Augmented BNF for Syntax Specifications: 175 ABNF", RFC 4234, October 2005. 177 [IMAP4] Crispin, M., "Internet Message Access Protocol - Version 178 4rev1", RFC 3501, University of Washington, March 2003. 180 [SORT] Crispin, M., Murchison, K., "Internet Message Access Protocol -- 181 SORT AND THREAD EXTENSIONS", work in progress. 182 184 [CONDSTORE] Melnikov, A. and S. Hole, "IMAP Extension for Conditional 185 STORE operation", work in progress. 186 188 <<[IMAPABNF] Melnikov, A., "Collected extensions to IMAP4 ABNF", 189 work in progress.>> 190 192 7. IANA Considerations 194 IMAP4 capabilities are registered by publishing a standards track or 195 IESG approved experimental RFC. The registry is currently located 196 at: 198 http://www.iana.org/assignments/imap4-capabilities 200 This document defines the SORT=MODSEQ IMAP capability. 201 IANA should add them to the registry accordingly. 203 8. Author's Addresses 205 Alexey Melnikov 206 mailto: Alexey.Melnikov@isode.com 208 Isode Limited 209 5 Castle Business Village, 36 Station Road, 210 Hampton, Middlesex, TW12 2BX, United Kingdom 212 Steve Hole 213 mailto: Steve.Hole@messagingdirect.com 215 ACI WorldWide/MessagingDirect 216 #900, 10117 Jasper Avenue, 217 Edmonton, Alberta, T5J 1W8, CANADA 219 9. Intellectual Property Statement 221 The IETF takes no position regarding the validity or scope of any 222 Intellectual Property Rights or other rights that might be claimed to 223 pertain to the implementation or use of the technology described in 224 this document or the extent to which any license under such rights 225 might or might not be available; nor does it represent that it has 226 made any independent effort to identify any such rights. Information 227 on the procedures with respect to rights in RFC documents can be 228 found in BCP 78 and BCP 79. 230 Copies of IPR disclosures made to the IETF Secretariat and any 231 assurances of licenses to be made available, or the result of an 232 attempt made to obtain a general license or permission for the use of 233 such proprietary rights by implementers or users of this 234 specification can be obtained from the IETF on-line IPR repository at 235 http://www.ietf.org/ipr. 237 The IETF invites any interested party to bring to its attention any 238 copyrights, patents or patent applications, or other proprietary 239 rights that may cover technology that may be required to implement 240 this standard. Please address the information to the IETF at 241 ietf-ipr@ietf.org. 243 The IETF has been notified of intellectual property rights claimed in 244 regard to some or all of the specification contained in this 245 document. For more information consult the online list of claimed 246 rights. 248 Disclaimer of Validity 250 This document and the information contained herein are provided on an 251 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 252 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 253 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 254 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 255 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 256 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 258 Copyright Statement 260 Copyright (C) The Internet Society (2005). This document is subject 261 to the rights, licenses and restrictions contained in BCP 78, and 262 except as set forth therein, the authors retain all their rights. 264 Acknowledgment 266 Funding for the RFC Editor function is currently provided by the 267 Internet Society. 269 Appendix A. Change History 271 Note that this appendix will be removed before publication. 273 0.1. Change History