idnits 2.17.1 draft-ietf-extra-sieve-fcc-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 : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 2 characters in excess of 72. -- The draft header indicates that this document updates RFC5435, but the abstract doesn't seem to mention this, which it should. -- The draft header indicates that this document updates RFC5230, but the abstract doesn't seem to mention this, which it should. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year (Using the creation date from RFC5230, updated by this document, for RFC5378 checks: 2005-03-16) -- 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 (April 29, 2018) is 2189 days in the past. Is this intentional? 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: 'FCC' is mentioned on line 186, but not defined == Outdated reference: A later version (-05) exists of draft-ietf-extra-sieve-special-use-02 ** Obsolete normative reference: RFC 4234 (Obsoleted by RFC 5234) Summary: 2 errors (**), 0 flaws (~~), 3 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 EXTRA K. Murchison 3 Internet-Draft B. Gondwana 4 Updates: 5230, 5435 (if approved) FastMail 5 Intended status: Standards Track April 29, 2018 6 Expires: October 31, 2018 8 Sieve Extension: File Carbon Copy (Fcc) 9 draft-ietf-extra-sieve-fcc-02 11 Abstract 13 The Sieve Email Filtering Language provides a number of action 14 commands, some of which can generate additional messages on behalf of 15 the user. This document defines an extension to such commands to 16 allow a copy of any generated message to be filed into a target 17 mailbox. 19 Status of This Memo 21 This Internet-Draft is submitted in full conformance with the 22 provisions of BCP 78 and BCP 79. 24 Internet-Drafts are working documents of the Internet Engineering 25 Task Force (IETF). Note that other groups may also distribute 26 working documents as Internet-Drafts. The list of current Internet- 27 Drafts is at https://datatracker.ietf.org/drafts/current/. 29 Internet-Drafts are draft documents valid for a maximum of six months 30 and may be updated, replaced, or obsoleted by other documents at any 31 time. It is inappropriate to use Internet-Drafts as reference 32 material or to cite them other than as "work in progress." 34 This Internet-Draft will expire on October 31, 2018. 36 Copyright Notice 38 Copyright (c) 2018 IETF Trust and the persons identified as the 39 document authors. All rights reserved. 41 This document is subject to BCP 78 and the IETF Trust's Legal 42 Provisions Relating to IETF Documents 43 (https://trustee.ietf.org/license-info) in effect on the date of 44 publication of this document. Please review these documents 45 carefully, as they describe your rights and restrictions with respect 46 to this document. Code Components extracted from this document must 47 include Simplified BSD License text as described in Section 4.e of 48 the Trust Legal Provisions and are provided without warranty as 49 described in the Simplified BSD License. 51 Table of Contents 53 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 54 2. Conventions Used in This Document . . . . . . . . . . . . . . 3 55 3. Tagged Argument ":fcc" . . . . . . . . . . . . . . . . . . . 3 56 3.1. Format of Filed Messages . . . . . . . . . . . . . . . . 3 57 3.2. Interaction with the Vacation Action . . . . . . . . . . 4 58 3.3. Interaction with the Notify Action . . . . . . . . . . . 4 59 3.4. Compatibility with the Reject and Extended Reject 60 Actions . . . . . . . . . . . . . . . . . . . . . . . . . 5 61 3.5. Compatibility with Other Actions . . . . . . . . . . . . 5 62 3.6. Interaction with Fileinto Extensions . . . . . . . . . . 6 63 3.6.1. Imap4flags Extension . . . . . . . . . . . . . . . . 6 64 3.6.2. Mailbox Extension . . . . . . . . . . . . . . . . . . 6 65 3.6.3. Special-Use Extension . . . . . . . . . . . . . . . . 6 66 3.6.4. Extended Example . . . . . . . . . . . . . . . . . . 7 67 4. Security Considerations . . . . . . . . . . . . . . . . . . . 7 68 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 69 5.1. Registration of Sieve Extension . . . . . . . . . . . . . 7 70 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 7 71 7. References . . . . . . . . . . . . . . . . . . . . . . . . . 7 72 7.1. Normative References . . . . . . . . . . . . . . . . . . 8 73 7.2. Informative References . . . . . . . . . . . . . . . . . 9 74 Appendix A. Change History (To be removed by RFC Editor before 75 publication) . . . . . . . . . . . . . . . . . . . . 9 76 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 78 1. Introduction 80 The Sieve Email Filtering Language [RFC5228] provides a number of 81 action commands, some of which can generate additional messages on 82 behalf of the user. Two such commands are defined by the Vacation 83 [RFC5230] and Notify [RFC5435] extensions. It is sometimes desirable 84 to have an archive of the messages generated by these commands. 86 This extension defines a new optional tagged argument ":fcc" to 87 action commands which generate additional messages to allow a copy of 88 the generated message to be filed into a target mailbox. 90 The capability string associated with this extension is "fcc". 92 2. Conventions Used in This Document 94 Conventions for notations are as in Section 1.1 of [RFC5228], 95 including use of the "Usage:" label for the definition of action and 96 tagged arguments syntax. 98 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 99 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 100 "OPTIONAL" in this document are to be interpreted as described in 101 [RFC2119]. 103 3. Tagged Argument ":fcc" 105 For convenience, the "FCC" syntax element is defined here using ABNF 106 [RFC4234] so that it can be augmented by other extensions. 108 FCC = ":fcc" 110 If the optional ":fcc" argument is specified with an action that 111 generates an additional message, it instructs the Sieve interpreter 112 to file a copy of the generated message into the target mailbox. If 113 the specified mailbox doesn't exist, the implementation MAY treat it 114 as an error, create the mailbox, or file the message into an 115 implementation-defined mailbox. 117 3.1. Format of Filed Messages 119 Copies of messages filed into a mailbox via this extension are 120 REQUIRED to be in Internet Message Format [RFC5322]. Some messages 121 generated by Sieve actions might already conform to this format and 122 MAY be filed without modification. Messages generated in other 123 formats MUST be encapsulated using constructs from [RFC5322] and MIME 124 ([RFC2045], [RFC2046], [RFC2047]). 126 The general requirements for encapsulating the copies of messages to 127 be filed are the following: 129 o Date: The Date header field is REQUIRED and SHOULD be set to the 130 date and time when the message was generated. 132 o From: The From header field is REQUIRED and SHOULD be set to the 133 email address of the owner of the Sieve script, unless explicitly 134 overridden by rules for encapsulating a particular message type. 136 o To: The To header field is OPTIONAL and MAY be set to the email 137 address of the recipient of the generated message, if available. 139 o Subject: The Subject header field is OPTIONAL and MAY be generated 140 as follows: The subject is set to the characters "Fcc: " followed 141 by the subject of the message being processed by the Sieve 142 interpreter. 144 o In-Reply-To: The In-Reply-To header field is OPTIONAL and MAY be 145 set to the Message-ID of the message being processed by the Sieve 146 interpreter. 148 o Message Body: The body of the filed message is REQUIRED and is 149 composed of one or more MIME-parts containing the generated 150 message and any related metadata. The Content-Type header 151 field(s) MUST be set to the appropriate MIME types. If any of the 152 MIME-parts include 8-bit or binary data, the Content-Transfer- 153 Encoding header field(s) MUST be set accordingly. 155 3.2. Interaction with the Vacation Action 157 This document extends the "vacation" [RFC5230] action (see also 158 "vacation-seconds" [RFC6131]) to optionally store a copy of the auto- 159 reply messages into a target mailbox. 161 Usage: vacation [FCC] 162 [":days" number | ":seconds" number] 163 [":subject" string] 164 [":from" string] 165 [":addresses" string-list] 166 [":mime"] 167 [":handle" string] 168 170 Example: 172 require ["vacation", "fcc"]; 174 vacation :days 7 175 :from "hemingway@example.com" "Gone Fishin'" 176 :fcc "INBOX.Sent"; 178 Vacation auto-reply messages are MIME-compliant and MAY be filed into 179 the target mailbox without modification. 181 3.3. Interaction with the Notify Action 183 This document extends the "notify" [RFC5435] action to optionally 184 store a copy of the notification messages into a target mailbox. 186 Usage: notify [FCC] 187 [":from" string] 188 [":importance" <"1" / "2" / "3">] 189 [":options" string-list] 190 [":message" string] 191 193 Example: 195 require ["enotify", "fcc"]; 197 notify :fcc "INBOX.Sent" 198 :message "You got mail!" 199 "mailto:ken@example.com"; 201 Messages generated using the "mailto" [RFC5436] notification method 202 are MIME-compliant and MAY be filed into the target mailbox without 203 modification. 205 Messages generated by other notification methods (e.g. "xmpp" 206 [RFC5437]) MUST be encapsulated per Section 3.1 before being filed. 207 The body of the filed message MUST include the :message parameter and 208 MAY include one or more of the :from, :importance, or :options 209 parameters. The MIME-type(s) of the body part(s) used to encapsulate 210 the parameters is an implementation decision. 212 3.4. Compatibility with the Reject and Extended Reject Actions 214 "fcc" MUST be incompatible with the "reject" and "ereject" [RFC5429] 215 actions. Making "fcc" compatible with these actions violates the 216 SMTP [RFC5321] principle that a message is either delivered or 217 bounced back to the sender. Namely, the saved copy of the rejection 218 message will contain the original message. 220 It is an error for a script to use the ":fcc" tagged argument with 221 either "reject" or "ereject". 223 3.5. Compatibility with Other Actions 225 The "fcc" extension is not compatible with any Sieve action that does 226 not generate an additional message on behalf of the user. It is an 227 error for a script to use the ":fcc" tagged argument with any such 228 action. 230 Future extensions that define actions that generate additional 231 messages on behalf of the user should describe their compatibility 232 with ":fcc", and how to MIME-encapsulate the message, if required. 234 3.6. Interaction with Fileinto Extensions 236 The "fcc" extension can be used with some tagged arguments defined in 237 extensions to the "fileinto" action. The sections below describe its 238 interaction with currently defined extensions. Tagged arguments in 239 future extensions to the "fileinto" command should describe their 240 interaction with ":fcc", if any. 242 3.6.1. Imap4flags Extension 244 This document extends the definition of the ":flags" [RFC5232] tagged 245 argument so that it can optionally be used with the ":fcc" argument. 247 FCC =/ [":flags" ] 249 If the optional ":flags" argument is specified with ":fcc", it 250 instructs the Sieve interpreter to set the IMAP4 flags provided in 251 the subsequent argument when the generated message is filed into the 252 target mailbox. 254 3.6.2. Mailbox Extension 256 This document extends the definition of the ":create" [RFC5490] 257 tagged argument so that it can optionally be used with the ":fcc" 258 argument. 260 FCC =/ [":create"] 262 If the optional ":create" argument is specified with ":fcc", it 263 instructs the Sieve interpreter to create the target mailbox, if 264 needed, before attempting to file the generated message into the 265 target mailbox. 267 3.6.3. Special-Use Extension 269 This document extends the definition of the ":specialuse" 270 [I-D.ietf-extra-sieve-special-use] tagged argument so that it can 271 optionally be used with the ":fcc" argument. 273 FCC =/ [":specialuse "] 275 If the optional ":specialuse" argument is specified with ":fcc", it 276 instructs the Sieve interpreter to check whether a mailbox exists 277 with the specific special-use flag assigned to it. If such a mailbox 278 exists, the generated message is filed into the special-use mailbox. 279 Otherwise, the generated message is filed into the target mailbox. 281 If both the optional ":specialuse" and ":create" arguments are 282 specified with ":fcc", the Sieve interpreter is instructed to create 283 the target mailbox per Section 4.1 of 284 [I-D.ietf-extra-sieve-special-use], if needed. 286 3.6.4. Extended Example 288 require ["vacation", "fcc", "mailbox", "special-use", "imap4flags"]; 290 vacation :days 7 291 :from "hemingway@example.com" "Gone Fishin'" 292 :fcc "INBOX.Sent" :specialuse "\\Sent" :create :flags ["\\Seen"]; 294 4. Security Considerations 296 The "fcc" extension does not raise any other security considerations 297 that are not already present in [RFC5228], [RFC5230], [RFC5435], and 298 [RFC6131]. 300 5. IANA Considerations 302 5.1. Registration of Sieve Extension 304 To: iana@iana.org 306 Subject: Registration of new Sieve extension 308 Capability name: fcc 310 Description: Adds the ":fcc" parameter to Sieve action commands 311 that generate additional messages. 313 RFC number: RFC XXXX 315 Contact address: The Sieve discussion list 317 6. Acknowledgments 319 The authors would like to thank the following individuals for 320 contributing their ideas and support for writing this specification: 321 Ned Freed, Stan Kalisch, and Alexey Melnikov. 323 7. References 324 7.1. Normative References 326 [I-D.ietf-extra-sieve-special-use] 327 Bosch, S., "Sieve Email Filtering: Delivering to Special- 328 Use Mailboxes", draft-ietf-extra-sieve-special-use-02 329 (work in progress), March 2018. 331 [RFC2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 332 Extensions (MIME) Part One: Format of Internet Message 333 Bodies", RFC 2045, DOI 10.17487/RFC2045, November 1996, 334 . 336 [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 337 Extensions (MIME) Part Two: Media Types", RFC 2046, 338 DOI 10.17487/RFC2046, November 1996, 339 . 341 [RFC2047] Moore, K., "MIME (Multipurpose Internet Mail Extensions) 342 Part Three: Message Header Extensions for Non-ASCII Text", 343 RFC 2047, DOI 10.17487/RFC2047, November 1996, 344 . 346 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 347 Requirement Levels", BCP 14, RFC 2119, 348 DOI 10.17487/RFC2119, March 1997, 349 . 351 [RFC4234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax 352 Specifications: ABNF", RFC 4234, DOI 10.17487/RFC4234, 353 October 2005, . 355 [RFC5228] Guenther, P., Ed. and T. Showalter, Ed., "Sieve: An Email 356 Filtering Language", RFC 5228, DOI 10.17487/RFC5228, 357 January 2008, . 359 [RFC5230] Showalter, T. and N. Freed, Ed., "Sieve Email Filtering: 360 Vacation Extension", RFC 5230, DOI 10.17487/RFC5230, 361 January 2008, . 363 [RFC5232] Melnikov, A., "Sieve Email Filtering: Imap4flags 364 Extension", RFC 5232, DOI 10.17487/RFC5232, January 2008, 365 . 367 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 368 DOI 10.17487/RFC5322, October 2008, 369 . 371 [RFC5435] Melnikov, A., Ed., Leiba, B., Ed., Segmuller, W., and T. 372 Martin, "Sieve Email Filtering: Extension for 373 Notifications", RFC 5435, DOI 10.17487/RFC5435, January 374 2009, . 376 [RFC5490] Melnikov, A., "The Sieve Mail-Filtering Language -- 377 Extensions for Checking Mailbox Status and Accessing 378 Mailbox Metadata", RFC 5490, DOI 10.17487/RFC5490, March 379 2009, . 381 7.2. Informative References 383 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, 384 DOI 10.17487/RFC5321, October 2008, 385 . 387 [RFC5429] Stone, A., Ed., "Sieve Email Filtering: Reject and 388 Extended Reject Extensions", RFC 5429, 389 DOI 10.17487/RFC5429, March 2009, 390 . 392 [RFC5436] Leiba, B. and M. Haardt, "Sieve Notification Mechanism: 393 mailto", RFC 5436, DOI 10.17487/RFC5436, January 2009, 394 . 396 [RFC5437] Saint-Andre, P. and A. Melnikov, "Sieve Notification 397 Mechanism: Extensible Messaging and Presence Protocol 398 (XMPP)", RFC 5437, DOI 10.17487/RFC5437, January 2009, 399 . 401 [RFC6131] George, R. and B. Leiba, "Sieve Vacation Extension: 402 "Seconds" Parameter", RFC 6131, DOI 10.17487/RFC6131, July 403 2011, . 405 Appendix A. Change History (To be removed by RFC Editor before 406 publication) 408 Changes since draft-ietf-extra-sieve-fcc-01: 410 o Added text discussing how to handle generated messages that are 411 not in MIME format. 413 o Adjusted ABNF so that tagged arguments that supplement :fcc no 414 longer appear as positional. 416 Changes since draft-ietf-extra-sieve-fcc-00: 418 o Updated abstract with text from Ned. 420 o Added support for :fcc to notify extension. 422 o Prohibit use of :fcc with reject and ereject extensions. 424 o Added registration of the extension with IANA. 426 o Added Acknowledgments. 428 o Minor editorial changes. 430 Authors' Addresses 432 Kenneth Murchison 433 FastMail Pty Ltd 434 Level 2, 114 William Street 435 Melbourne, VIC 3000 436 Australia 438 Email: murch@fastmailteam.com 440 Bron Gondwana 441 FastMail Pty Ltd 442 Level 2, 114 William Street 443 Melbourne, VIC 3000 444 Australia 446 Email: brong@fastmailteam.com