idnits 2.17.00 (12 Aug 2021) /tmp/idnits5578/draft-ietf-extra-sieve-mailboxid-02.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 (September 3, 2020) is 624 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) September 3, 2020 5 Intended status: Standards Track 6 Expires: March 7, 2021 8 Sieve Email Filtering: delivery by mailboxid 9 draft-ietf-extra-sieve-mailboxid-02 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 March 7, 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 5. Interaction with "fcc" extension . . . . . . . . . . . . . . 5 60 6. Test "mailboxidexists" . . . . . . . . . . . . . . . . . . . 5 61 7. Interaction with variables extension . . . . . . . . . . . . 6 62 8. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . . 6 63 9. Security considerations . . . . . . . . . . . . . . . . . . . 6 64 10. IANA considerations . . . . . . . . . . . . . . . . . . . . . 7 65 11. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 7 66 12. Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 67 12.1. draft-ietf-sieve-mailboxid-02 . . . . . . . . . . . . . 7 68 12.2. draft-ietf-sieve-mailboxid-01 . . . . . . . . . . . . . 7 69 12.3. draft-ietf-sieve-mailboxid-00 . . . . . . . . . . . . . 7 70 12.4. draft-gondwana-sieve-mailboxid-02 . . . . . . . . . . . 8 71 12.5. draft-gondwana-sieve-mailboxid-01 . . . . . . . . . . . 8 72 12.6. draft-gondwana-sieve-mailboxid-00 . . . . . . . . . . . 8 73 13. Normative References . . . . . . . . . . . . . . . . . . . . 8 74 14. Informative References . . . . . . . . . . . . . . . . . . . 9 75 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . 9 77 1. Introduction 79 [RFC5228] Sieve rules are sometimes created using graphical 80 interfaces which allow users to select the mailbox to be used as a 81 target for a rule. 83 If that mailbox is renamed, the client may also update its internal 84 representation of the rule and update the sieve script to match, 85 however this is a multi-step process and subject to partial failures. 86 Also, if the folder is renamed by a different mechanism (e.g. another 87 IMAP client) the rules will get out of sync. 89 By extending "fileinto" to reference the immutable mailboxid 90 specified by [RFC8474] , sieve rules can continue to target the same 91 mailbox, even if it gets renamed. 93 2. Conventions Used In This Document 95 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 96 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 97 "OPTIONAL" in this document are to be interpreted as described in BCP 98 14 [RFC2119] [RFC8174] when, and only when, they appear in all 99 capitals, as shown here. 101 3. Sieve capability string 103 The server advertises the capability "mailboxid", and scripts which 104 use the following extensions MUST explicitly request the capability 105 "mailboxid". 107 Example: 109 require "mailboxid"; 111 4. Argument ":mailboxid" to Command "fileinto" 113 Normally, the "fileinto" command delivers the message in the mailbox 114 specified using its positional mailbox argument. However, if the 115 optional ":mailboxid" argument is also specified, the "fileinto" 116 command first checks whether a mailbox exists in the user's personal 117 namespace [RFC2342] with the specified [RFC8474] MAILBOXID. 119 If a matching mailbox is found, that mailbox is used for delivery. 121 If there is no such mailbox, the "fileinto" action proceeds as it 122 would without the ":mailboxid" argument. 124 The tagged argument ":mailboxid" to fileinto consumes one additional 125 token, a string with the objectid of the mailbox to file into. 127 Example: 129 require "fileinto"; 130 require "mailboxid"; 132 if header :contains ["from"] "coyote" { 133 fileinto :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 134 "INBOX.harassment"; 135 } 137 4.1. Interaction with "mailbox" extension 139 For servers which also support the [RFC5490] mailbox extension, the 140 ":create" modifier to fileinto does not create the mailbox with the 141 specified mailboxid, however it may be specified and interacts as 142 normal with all other extensions. 144 Example: 146 require "fileinto"; 147 require "mailboxid"; 148 require "mailbox"; 150 fileinto :mailboxid "Fnosuch" 151 :create 152 "INBOX.no-such-folder"; 153 # creates INBOX.no-such-folder, but it doesn't 154 # get the "Fnosuch" mailboxid. 156 4.2. Interaction with "specialuse" extension 158 For servers which also support [RFC8579] delivery to special-use 159 mailboxes, if a fileinto command has both ":mailboxid" and ":special- 160 use" specified, then the mailboxid is resolved first. 162 If a mailbox with the specified mailboxid does not exist, then the 163 process specified in [RFC8579] is followed - which includes 164 processing of [RFC5490] ":create" tags to add the special-use to the 165 created mailbox. 167 Example: 169 require "fileinto"; 170 require "mailboxid"; 171 require "special-use"; 172 if header :contains ["from"] "coyote" { 173 fileinto :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 174 :specialuse "\\Junk" 175 "INBOX.harassment"; 176 } 178 Example: 180 require "fileinto"; 181 require "mailboxid"; 182 require "mailbox"; 183 require "special-use"; 185 fileinto :mailboxid "F1234567" 186 :specialuse "\\Archive" 187 :create 188 "INBOX.Archive"; 189 # creates INBOX.Archive with use \Archive but 190 # with a different mailboxid. 192 5. Interaction with "fcc" extension 194 This document extends the definition of the ":fcc" argument defined 195 in [RFC8580] so that it can optionally be used with the ":mailboxid" 196 argument. 198 FCC =/ [":mailboxid" ] 200 If the optional ":mailboxid" argument is specified with ":fcc", it 201 instructs the Sieve interpreter to check whether a mailbox exists 202 with the specific mailboxid. If such a mailbox exists, the generated 203 message is filed into that mailbox. Otherwise, the generated message 204 is filed into the ":fcc" target mailbox. 206 Example: 208 require ["enotify", "fcc", "mailboxid"]; 209 notify :fcc "INBOX.Sent" 210 :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 211 :message "You got mail!" 212 "mailto:ken@example.com"; 214 6. Test "mailboxidexists" 216 The "mailboxidexists" test is true if all mailboxes listed in the 217 "mailboxids" argument exist in the mailstore, and each allows the 218 user in whose context the Sieve script runs to "deliver" messages 219 into it. When the mailstore is an IMAP server, "delivery" of 220 messages is possible if: 222 a) the READ-WRITE response code is present for the mailbox (see 223 Section 7.1 of [RFC3501]), if IMAP Access Control List (ACL) 224 [RFC4314] is not supported by the server, or 226 b) the user has 'p' or 'i' rights for the mailbox (see Section 5.2 of 227 [RFC4314]). 229 Note that a successful "mailboxidexists" test for a mailbox doesn't 230 necessarily mean that a "fileinto :mailboxid" action on this mailbox 231 would succeed. For example, the "fileinto" action might put user 232 over quota. The "mailboxidexists" test only verifies existence of 233 the mailbox and whether the user in whose context the Sieve script 234 runs has permissions to execute "fileinto" on it. 236 Example: 238 require "fileinto"; 239 require "mailboxid"; 241 if header :contains ["from"] "coyote" { 242 if mailboxidexists "F6352ae03-b7f5-463c-896f-d8b48ee3" { 243 fileinto :mailboxid "F6352ae03-b7f5-463c-896f-d8b48ee3" 244 "INBOX.harassment"; 245 } else { 246 fileinto "INBOX.harassment"; 247 } 248 } 250 Note to implementers: this test behaves identically to the 251 "mailboxexists" test defined in [RFC5490] but operates on mailboxids 252 rather than mailbox names. 254 7. Interaction with variables extension 256 There is no special interaction defined, however as an objectid is a 257 string in this document, objectid values can contain variable 258 expansions if [RFC5229] is enabled. 260 8. Formal Syntax 262 test /= "mailboxidexists" string-list 264 tag /= ":mailboxid" string 266 If [RFC8580] is supported: 268 FCC =/ [":mailboxid" ] 270 9. Security considerations 272 Because mailboxid is always generated by the server, implementations 273 MUST NOT allow sieve to make an endrun around this protection by 274 creating mailboxes with the specified ID by using ":create" and 275 ":mailboxid" in a fileinto rule for a non-existant mailbox. 277 Implementers are referred to the security considerations sections of 278 [RFC5228] and [RFC8474]. 280 10. IANA considerations 282 IANA are requested to add a capability to the sieve-extensions 283 registry: 285 To: iana@iana.org 286 Subject: Registration of new Sieve extension 288 Capability name: mailboxid 289 Description: adds a test for checking mailbox existence by objectid, 290 and new optional arguments to fileinto and :fcc which 291 allow selecting the destination mailbox by objectid. 292 RFC number: this RFC 293 Contact address: The EXTRA discussion list 295 11. Acknowledgements 297 This document borrows heavily from [RFC5490] for the matching 298 mailboxexists test, and from [RFC8579] for an example of modifying 299 the fileinto command. 301 Thanks to Ned Freed and Ken Murchison and Alexey Melnikov for 302 feedback on the EXTRA mailing list. 304 12. Changes 306 (EDITOR: remove this section before publication) 308 12.1. draft-ietf-sieve-mailboxid-02 310 * removed bogus : from "mailboxidexists" test title 312 * moved FCC to its own top-level section since it is not used with 313 the fileinto command. 315 12.2. draft-ietf-sieve-mailboxid-01 317 * fixed idnits - RFC5228 not mentioned in the abstract 319 * fixed other I-D references I had missed, oops 321 12.3. draft-ietf-sieve-mailboxid-00 323 * Adopted into working group per adoption call on list 324 * Updated references to old drafts which have since been published. 326 * Fixed some typoes and simplified some language. 328 * Removed stray leading colon on mailboxexists (thanks Alexey) 330 * Added :fcc to the IANA registration description (thanks Alexey) 332 * Mentioned that variables can be expanded (thanks Alexey) 334 12.4. draft-gondwana-sieve-mailboxid-02 336 * Update document date by a couple of years! Ooops, it got 337 forgotten after a WGLC which got not dissent. 339 * Create xml2rfc v3 output. 341 12.5. draft-gondwana-sieve-mailboxid-01 343 * Switch to :mailboxid tagged parameter value with fallback mailbox 344 name. 346 * Document interaction with "mailbox". 348 * Document interaction with "special-use". 350 * Document interaction with "fcc". 352 * Document security considerations around :mailboxid and :create. 354 12.6. draft-gondwana-sieve-mailboxid-00 356 * Initial version. 358 13. Normative References 360 [RFC8474] Gondwana, B., Ed., "IMAP Extension for Object 361 Identifiers", RFC 8474, DOI 10.17487/RFC8474, September 362 2018, . 364 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 365 Requirement Levels", BCP 14, RFC 2119, 366 DOI 10.17487/RFC2119, March 1997, 367 . 369 [RFC2342] Gahrns, M. and C. Newman, "IMAP4 Namespace", RFC 2342, 370 DOI 10.17487/RFC2342, May 1998, 371 . 373 [RFC5228] Guenther, P., Ed. and T. Showalter, Ed., "Sieve: An Email 374 Filtering Language", RFC 5228, DOI 10.17487/RFC5228, 375 January 2008, . 377 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 378 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 379 May 2017, . 381 14. Informative References 383 [RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION 384 4rev1", RFC 3501, DOI 10.17487/RFC3501, March 2003, 385 . 387 [RFC4314] Melnikov, A., "IMAP4 Access Control List (ACL) Extension", 388 RFC 4314, DOI 10.17487/RFC4314, December 2005, 389 . 391 [RFC5229] Homme, K., "Sieve Email Filtering: Variables Extension", 392 RFC 5229, DOI 10.17487/RFC5229, January 2008, 393 . 395 [RFC5490] Melnikov, A., "The Sieve Mail-Filtering Language -- 396 Extensions for Checking Mailbox Status and Accessing 397 Mailbox Metadata", RFC 5490, DOI 10.17487/RFC5490, March 398 2009, . 400 [RFC8579] Bosch, S., "Sieve Email Filtering: Delivering to Special- 401 Use Mailboxes", RFC 8579, DOI 10.17487/RFC8579, May 2019, 402 . 404 [RFC8580] Murchison, K. and B. Gondwana, "Sieve Extension: File 405 Carbon Copy (FCC)", RFC 8580, DOI 10.17487/RFC8580, May 406 2019, . 408 Author's Address 410 Bron Gondwana (editor) 411 Fastmail 412 Level 2, 114 William St 413 Melbourne VIC 3000 414 Australia 416 Email: brong@fastmailteam.com 417 URI: https://www.fastmail.com