idnits 2.17.1 draft-ietf-extra-sieve-mailboxid-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- -- The draft header indicates that this document updates RFC5228, but the abstract doesn't seem to directly say this. It does mention RFC5228 though, so this could be OK. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year (Using the creation date from RFC5228, updated by this document, for RFC5378 checks: 2005-05-09) -- 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 (30 July 2020) is 1366 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) -- Obsolete informational reference (is this intentional?): RFC 3501 (Obsoleted by RFC 9051) Summary: 0 errors (**), 0 flaws (~~), 1 warning (==), 5 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 EXTRA B. Gondwana, Ed. 3 Internet-Draft Fastmail 4 Updates: 5228 (if approved) 30 July 2020 5 Intended status: Standards Track 6 Expires: 31 January 2021 8 Sieve Email Filtering: delivery by mailboxid 9 draft-ietf-extra-sieve-mailboxid-01 11 Abstract 13 The OBJECTID capability of the IMAP protocol (RFC8474) allows clients 14 to identify mailboxes by a unique identifier which survives rename. 16 This document extends the Sieve mail filtering language (RFC5228) to 17 allow using that same unique identifier as a target for fileinto 18 rules, and for testing the existance of mailboxes. 20 Status of This Memo 22 This Internet-Draft is submitted in full conformance with the 23 provisions of BCP 78 and BCP 79. 25 Internet-Drafts are working documents of the Internet Engineering 26 Task Force (IETF). Note that other groups may also distribute 27 working documents as Internet-Drafts. The list of current Internet- 28 Drafts is at https://datatracker.ietf.org/drafts/current/. 30 Internet-Drafts are draft documents valid for a maximum of six months 31 and may be updated, replaced, or obsoleted by other documents at any 32 time. It is inappropriate to use Internet-Drafts as reference 33 material or to cite them other than as "work in progress." 35 This Internet-Draft will expire on 31 January 2021. 37 Copyright Notice 39 Copyright (c) 2020 IETF Trust and the persons identified as the 40 document authors. All rights reserved. 42 This document is subject to BCP 78 and the IETF Trust's Legal 43 Provisions Relating to IETF Documents (https://trustee.ietf.org/ 44 license-info) in effect on the date of publication of this document. 45 Please review these documents carefully, as they describe your rights 46 and restrictions with respect to this document. Code Components 47 extracted from this document must include Simplified BSD License text 48 as described in Section 4.e of the Trust Legal Provisions and are 49 provided without warranty as described in the Simplified BSD License. 51 Table of Contents 53 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 54 2. Conventions Used In This Document . . . . . . . . . . . . . . 3 55 3. Sieve capability string . . . . . . . . . . . . . . . . . . . 3 56 4. Argument ":mailboxid" to Command "fileinto" . . . . . . . . . 3 57 4.1. Interaction with "mailbox" extension . . . . . . . . . . 4 58 4.2. Interaction with "specialuse" extension . . . . . . . . . 4 59 4.3. Interaction with "fcc" extension . . . . . . . . . . . . 5 60 5. Test ":mailboxidexists" . . . . . . . . . . . . . . . . . . . 5 61 6. Interaction with variables extension . . . . . . . . . . . . 6 62 7. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 6 63 8. Security considerations . . . . . . . . . . . . . . . . . . . 6 64 9. IANA considerations . . . . . . . . . . . . . . . . . . . . . 7 65 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7 66 11. Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 67 11.1. draft-ietf-sieve-mailboxid-01 . . . . . . . . . . . . . 7 68 11.2. draft-ietf-sieve-mailboxid-00 . . . . . . . . . . . . . 7 69 11.3. draft-gondwana-sieve-mailboxid-02 . . . . . . . . . . . 8 70 11.4. draft-gondwana-sieve-mailboxid-01 . . . . . . . . . . . 8 71 11.5. draft-gondwana-sieve-mailboxid-00 . . . . . . . . . . . 8 72 12. Normative References . . . . . . . . . . . . . . . . . . . . 8 73 13. Informative References . . . . . . . . . . . . . . . . . . . 9 74 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 9 76 1. Introduction 78 [RFC5228] Sieve rules are sometimes created using graphical 79 interfaces which allow users to select the mailbox to be used as a 80 target for a rule. 82 If that mailbox is renamed, the client may also update its internal 83 representation of the rule and update the sieve script to match, 84 however this is a multi-step process and subject to partial failures. 85 Also, if the folder is renamed by a different mechanism (e.g. another 86 IMAP client) the rules will get out of sync. 88 By extending "fileinto" to reference the immutable mailboxid 89 specified by [RFC8474] , sieve rules can continue to target the same 90 mailbox, even if it gets renamed. 92 2. Conventions Used In This Document 94 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 95 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 96 "OPTIONAL" in this document are to be interpreted as described in BCP 97 14 [RFC2119] [RFC8174] when, and only when, they appear in all 98 capitals, as shown here. 100 3. Sieve capability string 102 The server advertises the capability "mailboxid", and scripts which 103 use the following extensions MUST explicitly request the capability 104 "mailboxid". 106 Example: 108 require "mailboxid"; 110 4. Argument ":mailboxid" to Command "fileinto" 112 Normally, the "fileinto" command delivers the message in the mailbox 113 specified using its positional mailbox argument. However, if the 114 optional ":mailboxid" argument is also specified, the "fileinto" 115 command first checks whether a mailbox exists in the user's personal 116 namespace [RFC2342] with the specified [RFC8474] MAILBOXID. 118 If a matching mailbox is found, that mailbox is used for delivery. 120 If there is no such mailbox, the "fileinto" action proceeds as it 121 would without the ":mailboxid" argument. 123 The tagged argument ":mailboxid" to fileinto consumes one additional 124 token, a string with the objectid of the mailbox to file into. 126 Example: 128 require "fileinto"; 129 require "mailboxid"; 131 if header :contains ["from"] "coyote" { 132 fileinto :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 133 "INBOX.harassment"; 134 } 136 4.1. Interaction with "mailbox" extension 138 For servers which also support the [RFC5490] mailbox extension, the 139 ":create" modifier to fileinto does not create the mailbox with the 140 specified mailboxid, however it may be specified and interacts as 141 normal with all other extensions. 143 Example: 145 require "fileinto"; 146 require "mailboxid"; 147 require "mailbox"; 149 fileinto :mailboxid "Fnosuch" 150 :create 151 "INBOX.no-such-folder"; 152 # creates INBOX.no-such-folder, but it doesn't 153 # get the "Fnosuch" mailboxid. 155 4.2. Interaction with "specialuse" extension 157 For servers which also support [RFC8579] delivery to special-use 158 mailboxes, if a fileinto command has both ":mailboxid" and ":special- 159 use" specified, then the mailboxid is resolved first. 161 If a mailbox with the specified mailboxid does not exist, then the 162 process specified in [RFC8579] is followed - which includes 163 processing of [RFC5490] ":create" tags to add the special-use to the 164 created mailbox. 166 Example: 168 require "fileinto"; 169 require "mailboxid"; 170 require "special-use"; 171 if header :contains ["from"] "coyote" { 172 fileinto :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 173 :specialuse "\\Junk" 174 "INBOX.harassment"; 175 } 177 Example: 179 require "fileinto"; 180 require "mailboxid"; 181 require "mailbox"; 182 require "special-use"; 184 fileinto :mailboxid "F1234567" 185 :specialuse "\\Archive" 186 :create 187 "INBOX.Archive"; 188 # creates INBOX.Archive with use \Archive but 189 # with a different mailboxid. 191 4.3. Interaction with "fcc" extension 193 This document extends the definition of the ":fcc" argument defined 194 in [RFC8580] so that it can optionally be used with the ":mailboxid" 195 argument. 197 FCC =/ [":mailboxid" ] 199 If the optional ":mailboxid" argument is specified with ":fcc", it 200 instructs the Sieve interpreter to check whether a mailbox exists 201 with the specific mailboxid. If such a mailbox exists, the generated 202 message is filed into that mailbox. Otherwise, the generated message 203 is filed into the ":fcc" target mailbox. 205 Example: 207 require ["enotify", "fcc", "mailboxid"]; 208 notify :fcc "INBOX.Sent" 209 :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 210 :message "You got mail!" 211 "mailto:ken@example.com"; 213 5. Test ":mailboxidexists" 215 The "mailboxidexists" test is true if all mailboxes listed in the 216 "mailboxids" argument exist in the mailstore, and each allows the 217 user in whose context the Sieve script runs to "deliver" messages 218 into it. When the mailstore is an IMAP server, "delivery" of 219 messages is possible if: 221 a) the READ-WRITE response code is present for the mailbox (see 222 Section 7.1 of [RFC3501]), if IMAP Access Control List (ACL) 223 [RFC4314] is not supported by the server, or 225 b) the user has 'p' or 'i' rights for the mailbox (see Section 5.2 of 226 [RFC4314]). 228 Note that a successful "mailboxidexists" test for a mailbox doesn't 229 necessarily mean that a "fileinto :mailboxid" action on this mailbox 230 would succeed. For example, the "fileinto" action might put user 231 over quota. The "mailboxidexists" test only verifies existence of 232 the mailbox and whether the user in whose context the Sieve script 233 runs has permissions to execute "fileinto" on it. 235 Example: 237 require "fileinto"; 238 require "mailboxid"; 240 if header :contains ["from"] "coyote" { 241 if mailboxidexists "F6352ae03-b7f5-463c-896f-d8b48ee3" { 242 fileinto :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 243 "INBOX.harassment"; 244 } else { 245 fileinto "INBOX.harassment"; 246 } 247 } 249 Note to implementers: this test behaves identically to the 250 "mailboxexists" test defined in [RFC5490] but operates on mailboxids 251 rather than mailbox names. 253 6. Interaction with variables extension 255 There is no special interaction defined, however as an objectid is a 256 string in this document, objectid values can contain variable 257 expansions if [RFC5229] is enabled. 259 7. Formal Syntax 261 test /= "mailboxidexists" string-list 263 tag /= ":mailboxid" string 265 If [RFC8580] is supported: 267 FCC =/ [":mailboxid" ] 269 8. Security considerations 271 Because mailboxid is always generated by the server, implementations 272 MUST NOT allow sieve to make an endrun around this protection by 273 creating mailboxes with the specified ID by using ":create" and 274 ":mailboxid" in a fileinto rule for a non-existant mailbox. 276 Implementers are referred to the security considerations sections of 277 [RFC5228] and [RFC8474]. 279 9. IANA considerations 281 IANA are requested to add a capability to the sieve-extensions 282 registry: 284 To: iana@iana.org 285 Subject: Registration of new Sieve extension 287 Capability name: mailboxid 288 Description: adds a test for checking mailbox existence by objectid, 289 and new optional arguments to fileinto and :fcc which 290 allow selecting the destination mailbox by objectid. 291 RFC number: this RFC 292 Contact address: The EXTRA discussion list 294 10. Acknowledgements 296 This document borrows heavily from [RFC5490] for the matching 297 mailboxexists test, and from [RFC8579] for an example of modifying 298 the fileinto command. 300 Thanks to Ned Freed and Ken Murchison and Alexey Melnikov for 301 feedback on the EXTRA mailing list. 303 11. Changes 305 (EDITOR: remove this section before publication) 307 11.1. draft-ietf-sieve-mailboxid-01 309 * fixed idnits - RFC5228 not mentioned in the abstract 311 * fixed other I-D references I had missed, oops 313 11.2. draft-ietf-sieve-mailboxid-00 315 * Adopted into working group per adoption call on list 317 * Updated references to old drafts which have since been published. 319 * Fixed some typoes and simplified some language. 321 * Removed stray leading colon on mailboxexists (thanks Alexey) 323 * Added :fcc to the IANA registration description (thanks Alexey) 324 * Mentioned that variables can be expanded (thanks Alexey) 326 11.3. draft-gondwana-sieve-mailboxid-02 328 * Update document date by a couple of years! Ooops, it got 329 forgotten after a WGLC which got not dissent. 331 * Create xml2rfc v3 output. 333 11.4. draft-gondwana-sieve-mailboxid-01 335 * Switch to :mailboxid tagged parameter value with fallback mailbox 336 name. 338 * Document interaction with "mailbox". 340 * Document interaction with "special-use". 342 * Document interaction with "fcc". 344 * Document security considerations around :mailboxid and :create. 346 11.5. draft-gondwana-sieve-mailboxid-00 348 * Initial version. 350 12. Normative References 352 [RFC5228] Guenther, P., Ed. and T. Showalter, Ed., "Sieve: An Email 353 Filtering Language", RFC 5228, DOI 10.17487/RFC5228, 354 January 2008, . 356 [RFC8474] Gondwana, B., Ed., "IMAP Extension for Object 357 Identifiers", RFC 8474, DOI 10.17487/RFC8474, September 358 2018, . 360 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 361 Requirement Levels", BCP 14, RFC 2119, 362 DOI 10.17487/RFC2119, March 1997, 363 . 365 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 366 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 367 May 2017, . 369 [RFC2342] Gahrns, M. and C. Newman, "IMAP4 Namespace", RFC 2342, 370 DOI 10.17487/RFC2342, May 1998, 371 . 373 13. Informative References 375 [RFC5490] Melnikov, A., "The Sieve Mail-Filtering Language -- 376 Extensions for Checking Mailbox Status and Accessing 377 Mailbox Metadata", RFC 5490, DOI 10.17487/RFC5490, March 378 2009, . 380 [RFC8579] Bosch, S., "Sieve Email Filtering: Delivering to Special- 381 Use Mailboxes", RFC 8579, DOI 10.17487/RFC8579, May 2019, 382 . 384 [RFC8580] Murchison, K. and B. Gondwana, "Sieve Extension: File 385 Carbon Copy (FCC)", RFC 8580, DOI 10.17487/RFC8580, May 386 2019, . 388 [RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 389 4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003, 390 . 392 [RFC5229] Homme, K., "Sieve Email Filtering: Variables Extension", 393 RFC 5229, DOI 10.17487/RFC5229, January 2008, 394 . 396 [RFC4314] Melnikov, A., "IMAP4 Access Control List (ACL) Extension", 397 RFC 4314, DOI 10.17487/RFC4314, December 2005, 398 . 400 Author's Address 402 Bron Gondwana (editor) 403 Fastmail 404 Level 2, 114 William St 405 Melbourne VIC 3000 406 Australia 408 Email: brong@fastmailteam.com 409 URI: https://www.fastmail.com