idnits 2.17.1 draft-ietf-extra-sieve-fcc-04.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 == The document seems to lack the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords -- however, there's a paragraph with a matching beginning. Boilerplate error? (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). (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 (August 12, 2018) is 2077 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) -- Looks like a reference, but probably isn't: '1' on line 508 == Missing Reference: 'FCC' is mentioned on line 196, but not defined -- Looks like a reference, but probably isn't: '2' on line 510 -- Looks like a reference, but probably isn't: '3' on line 512 == Unused Reference: 'RFC5321' is defined on line 479, but no explicit reference was found in the text == Unused Reference: 'RFC5429' is defined on line 483, but no explicit reference was found in the text == 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 (~~), 6 warnings (==), 7 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 August 12, 2018 6 Expires: February 13, 2019 8 Sieve Extension: File Carbon Copy (Fcc) 9 draft-ietf-extra-sieve-fcc-04 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 February 13, 2019. 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 . . . . . . . . . . . 5 59 3.3.1. Notification-Capability "fcc" . . . . . . . . . . . . 5 60 3.4. Compatibility with Other Actions . . . . . . . . . . . . 6 61 3.5. Interaction with Fileinto Extensions . . . . . . . . . . 6 62 3.5.1. Imap4flags Extension . . . . . . . . . . . . . . . . 6 63 3.5.2. Mailbox Extension . . . . . . . . . . . . . . . . . . 7 64 3.5.3. Special-Use Extension . . . . . . . . . . . . . . . . 7 65 3.5.4. Extended Example . . . . . . . . . . . . . . . . . . 7 66 4. Implementation Status . . . . . . . . . . . . . . . . . . . . 8 67 5. Security Considerations . . . . . . . . . . . . . . . . . . . 8 68 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 69 6.1. Registration of Sieve Extension . . . . . . . . . . . . . 8 70 6.2. Registration of Notification-Capability 71 Parameter . . . . . . . . . . . . . . . . . . . . . . . . 9 72 7. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 9 73 8. References . . . . . . . . . . . . . . . . . . . . . . . . . 9 74 8.1. Normative References . . . . . . . . . . . . . . . . . . 9 75 8.2. Informative References . . . . . . . . . . . . . . . . . 11 76 8.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 11 77 Appendix A. Change History (To be removed by RFC Editor before 78 publication) . . . . . . . . . . . . . . . . . . . . 12 79 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 13 81 1. Introduction 83 The Sieve Email Filtering Language [RFC5228] provides a number of 84 action commands, some of which can generate additional messages on 85 behalf of the user. It is sometimes desirable to have an archive of 86 the messages generated by these commands. 88 This extension defines a new optional tagged argument ":fcc" to 89 action commands which generate additional messages to allow a copy of 90 the generated message to be filed into a target mailbox. 92 The capability string associated with this extension is "fcc". 94 Each action that generates additional messages will need to specify 95 how it interfacts with :fcc. This document also specifies the 96 interaction of :fcc with the Vacation [RFC5230] and Notify [RFC5435] 97 extensions. 99 2. Conventions Used in This Document 101 Conventions for notations are as in Section 1.1 of [RFC5228], 102 including use of the "Usage:" label for the definition of action and 103 tagged arguments syntax. 105 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 106 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 107 "OPTIONAL" in this document are to be interpreted as described in BCP 108 14 [1] [RFC2119] [RFC8174] when, and only when, they appear in all 109 capitals, as shown here. 111 3. Tagged Argument ":fcc" 113 For convenience, the "FCC" syntax element is defined here using ABNF 114 [RFC4234] so that it can be augmented by other extensions. 116 FCC = ":fcc" 118 If the optional ":fcc" argument is specified with an action that 119 generates an additional message, it instructs the Sieve interpreter 120 to file a copy of the generated message into the target mailbox. The 121 syntax and semantics of the mailbox argument MUST match those of the 122 mailbox argument to the "fileinto" action specified in Section 4.1 of 123 [RFC5228]. If the specified mailbox doesn't exist, the 124 implementation MAY treat it as an error, create the mailbox, or file 125 the message into an implementation-defined mailbox. 127 3.1. Format of Filed Messages 129 Copies of messages filed into a mailbox via this extension are 130 REQUIRED to be in Internet Message Format [RFC5322]. Some messages 131 generated by Sieve actions might already conform to this format and 132 MAY be filed without modification. Messages generated in other 133 formats MUST be encapsulated using constructs from [RFC5322] and MIME 134 ([RFC2045], [RFC2046], [RFC2047]). 136 The general requirements for encapsulating the copies of messages to 137 be filed are the following: 139 o Date: The Date header field is REQUIRED and SHOULD be set to the 140 date and time when the message was generated. 142 o From: The From header field is REQUIRED and SHOULD be set to the 143 email address of the owner of the Sieve script, unless explicitly 144 overridden by rules for encapsulating a particular message type. 146 o To: The To header field is OPTIONAL and MAY be set to the email 147 address of the recipient of the generated message, if available. 149 o Subject: The Subject header field is OPTIONAL and MAY be generated 150 as follows: The subject is set to the characters "Fcc: " followed 151 by the subject of the message being processed by the Sieve 152 interpreter. 154 o In-Reply-To: The In-Reply-To header field is OPTIONAL and MAY be 155 set to the Message-ID of the message being processed by the Sieve 156 interpreter. 158 o Message Body: The body of the filed message is REQUIRED and is 159 composed of one or more MIME-parts containing the generated 160 message and any related metadata. The Content-Type header 161 field(s) MUST be set to the appropriate MIME types. If any of the 162 MIME-parts include 8-bit or binary data, the Content-Transfer- 163 Encoding header field(s) MUST be set accordingly. 165 3.2. Interaction with the Vacation Action 167 This document extends the "vacation" [RFC5230] action (see also 168 "vacation-seconds" [RFC6131]) to optionally store a copy of the auto- 169 reply messages into a target mailbox. 171 Usage: vacation [FCC] 172 [":days" number | ":seconds" number] 173 [":subject" string] 174 [":from" string] 175 [":addresses" string-list] 176 [":mime"] 177 [":handle" string] 178 180 Example: 182 require ["vacation", "fcc"]; 184 vacation :days 7 185 :from "hemingway@example.com" "Gone Fishin'" 186 :fcc "INBOX.Sent"; 188 Vacation auto-reply messages are MIME-compliant and MAY be filed into 189 the target mailbox without modification. 191 3.3. Interaction with the Notify Action 193 This document extends the "notify" [RFC5435] action to optionally 194 store a copy of the notification messages into a target mailbox. 196 Usage: notify [FCC] 197 [":from" string] 198 [":importance" <"1" / "2" / "3">] 199 [":options" string-list] 200 [":message" string] 201 203 Example: 205 require ["enotify", "fcc"]; 207 notify :fcc "INBOX.Sent" 208 :message "You got mail!" 209 "mailto:ken@example.com"; 211 Messages generated using the "mailto" [RFC5436] notification method 212 are MIME-compliant and MAY be filed into the target mailbox without 213 modification. 215 Messages generated by other notification methods (e.g. "xmpp" 216 [RFC5437]) MUST be encapsulated per Section 3.1 before being filed. 217 The body of the filed message MUST include the :message parameter and 218 MAY include one or more of the :from, :importance, or :options 219 parameters. The MIME-type(s) of the body part(s) used to encapsulate 220 the parameters is an implementation decision. 222 An implementation MAY only support :fcc in conjunction with a subset 223 of the notification methods it supports. An error occurs if :fcc is 224 combined with a notification method that doesn't support it. 225 Notification methods that support :fcc can be discovered at run-time 226 using the mechanism described below (Section 3.3.1). 228 3.3.1. Notification-Capability "fcc" 230 This document defines a new notification-capability value "fcc" for 231 use with the notify_method_capability test (see Section 5 of 232 [RFC5435]. For the "fcc" notification-capability, the 233 notify_method_capability test can match one of the following key-list 234 values: 236 yes A copy of the notification message sent using the method 237 identified by the notification-uri can be filed into a target 238 mailbox. 240 no A copy of the notification message sent using the method 241 identified by the notification-uri can not be filed into a target 242 mailbox. 244 Example: 246 require ["enotify", "fcc"]; 248 if notify_method_capability "xmpp:" "Fcc" "yes" { 249 notify :fcc "INBOX.Sent" 250 :message "You got mail" 251 "xmpp:ken@example.com?message;subject=SIEVE"; 252 } else { 253 notify :fcc "INBOX.Sent" 254 :message "You got mail!" 255 "mailto:ken@example.com"; 256 } 258 3.4. Compatibility with Other Actions 260 The "fcc" extension is not compatible with any Sieve action that does 261 not generate an additional message on behalf of the user. It is an 262 error for a script to use the ":fcc" tagged argument with any such 263 action. 265 Future extensions that define actions that generate additional 266 messages on behalf of the user should describe their compatibility 267 with ":fcc", and how to MIME-encapsulate the message, if required. 269 3.5. Interaction with Fileinto Extensions 271 The "fcc" extension can be used with some tagged arguments defined in 272 extensions to the "fileinto" action. The sections below describe its 273 interaction with currently defined extensions. Tagged arguments in 274 future extensions to the "fileinto" command should describe their 275 interaction with ":fcc", if any. 277 When any "fileinto" extension arguments are used with ":fcc", the 278 MUST have the same syntax and semantics as they do with "fileinto". 280 3.5.1. Imap4flags Extension 282 This document extends the definition of the ":flags" [RFC5232] tagged 283 argument so that it can optionally be used with the ":fcc" argument. 285 FCC =/ [":flags" ] 286 If the optional ":flags" argument is specified with ":fcc", it 287 instructs the Sieve interpreter to set the IMAP4 flags provided in 288 the subsequent argument when the generated message is filed into the 289 target mailbox. 291 3.5.2. Mailbox Extension 293 This document extends the definition of the ":create" [RFC5490] 294 tagged argument so that it can optionally be used with the ":fcc" 295 argument. 297 FCC =/ [":create"] 299 If the optional ":create" argument is specified with ":fcc", it 300 instructs the Sieve interpreter to create the target mailbox, if 301 needed, before attempting to file the generated message into the 302 target mailbox. 304 3.5.3. Special-Use Extension 306 This document extends the definition of the ":specialuse" 307 [I-D.ietf-extra-sieve-special-use] tagged argument so that it can 308 optionally be used with the ":fcc" argument. 310 FCC =/ [":specialuse" ] 312 If the optional ":specialuse" argument is specified with ":fcc", it 313 instructs the Sieve interpreter to check whether a mailbox exists 314 with the specific special-use flag assigned to it. If such a mailbox 315 exists, the generated message is filed into the special-use mailbox. 316 Otherwise, the generated message is filed into the target mailbox. 318 If both the optional ":specialuse" and ":create" arguments are 319 specified with ":fcc", the Sieve interpreter is instructed to create 320 the target mailbox per Section 4.1 of 321 [I-D.ietf-extra-sieve-special-use], if needed. 323 3.5.4. Extended Example 325 require ["vacation", "fcc", "mailbox", "special-use", "imap4flags"]; 327 vacation :days 7 328 :from "hemingway@example.com" "Gone Fishin'" 329 :fcc "INBOX.Sent" :specialuse "\\Sent" :create :flags ["\\Seen"]; 331 4. Implementation Status 333 < RFC Editor: before publication please remove this section and the 334 reference to [RFC7942] > 336 This section records the status of known implementations of the 337 protocol defined by this specification at the time of posting of this 338 Internet-Draft, and is based on a proposal described in [RFC7942]. 339 The description of implementations in this section is intended to 340 assist the IETF in its decision processes in progressing drafts to 341 RFCs. Please note that the listing of any individual implementation 342 here does not imply endorsement by the IETF. Furthermore, no effort 343 has been spent to verify the information presented here that was 344 supplied by IETF contributors. This is not intended as, and must not 345 be construed to be, a catalog of available implementations or their 346 features. Readers are advised to note that other implementations may 347 exist. 349 According to [RFC7942], "this will allow reviewers and working groups 350 to assign due consideration to documents that have the benefit of 351 running code, which may serve as evidence of valuable experimentation 352 and feedback that have made the implemented protocols more mature. 353 It is up to the individual working groups to use this information as 354 they see fit". 356 4.1. Cyrus Server 358 The open source Cyrus Server [2] project is a highly scalable 359 enterprise mail system which supports Sieve email filtering at the 360 point of final delivery. This production level Sieve implementation 361 supports all of the requirements described in this document. This 362 implementation is freely distributable under a BSD style license from 363 Computing Services at Carnegie Mellon University [3]. 365 5. Security Considerations 367 The "fcc" extension does not raise any other security considerations 368 that are not already present in [RFC5228], [RFC5230], [RFC5435], and 369 [RFC6131]. 371 6. IANA Considerations 373 6.1. Registration of Sieve Extension 375 To: iana@iana.org 377 Subject: Registration of new Sieve extension 378 Capability name: fcc 380 Description: Adds the ":fcc" parameter to Sieve action commands 381 that generate additional messages. 383 RFC number: RFC XXXX 385 Contact address: The Sieve discussion list 387 6.2. Registration of Notification-Capability Parameter 389 To: iana@iana.org 391 Subject: Registration of a new notification-capability parameter 393 Capability name: fcc 395 Description: Returns whether a copy of the notification message 396 sent using the method identified by the notification-uri parameter 397 to the notify_method_capability test can be filed into a target 398 mailbox. 400 Syntax: Can contain one of two values: "yes" or "no". Values MUST 401 be in lowercase. 403 Permanent and readily available reference(s): This RFC 405 Contact information: The Sieve discussion list 408 7. Acknowledgments 410 The authors would like to thank the following individuals for 411 contributing their ideas and support for writing this specification: 412 Ned Freed, Stan Kalisch, and Alexey Melnikov. 414 8. References 416 8.1. Normative References 418 [I-D.ietf-extra-sieve-special-use] 419 Bosch, S., "Sieve Email Filtering: Delivering to Special- 420 Use Mailboxes", draft-ietf-extra-sieve-special-use-02 421 (work in progress), March 2018. 423 [RFC2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 424 Extensions (MIME) Part One: Format of Internet Message 425 Bodies", RFC 2045, DOI 10.17487/RFC2045, November 1996, 426 . 428 [RFC2046] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 429 Extensions (MIME) Part Two: Media Types", RFC 2046, 430 DOI 10.17487/RFC2046, November 1996, 431 . 433 [RFC2047] Moore, K., "MIME (Multipurpose Internet Mail Extensions) 434 Part Three: Message Header Extensions for Non-ASCII Text", 435 RFC 2047, DOI 10.17487/RFC2047, November 1996, 436 . 438 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 439 Requirement Levels", BCP 14, RFC 2119, 440 DOI 10.17487/RFC2119, March 1997, 441 . 443 [RFC4234] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax 444 Specifications: ABNF", RFC 4234, DOI 10.17487/RFC4234, 445 October 2005, . 447 [RFC5228] Guenther, P., Ed. and T. Showalter, Ed., "Sieve: An Email 448 Filtering Language", RFC 5228, DOI 10.17487/RFC5228, 449 January 2008, . 451 [RFC5230] Showalter, T. and N. Freed, Ed., "Sieve Email Filtering: 452 Vacation Extension", RFC 5230, DOI 10.17487/RFC5230, 453 January 2008, . 455 [RFC5232] Melnikov, A., "Sieve Email Filtering: Imap4flags 456 Extension", RFC 5232, DOI 10.17487/RFC5232, January 2008, 457 . 459 [RFC5322] Resnick, P., Ed., "Internet Message Format", RFC 5322, 460 DOI 10.17487/RFC5322, October 2008, 461 . 463 [RFC5435] Melnikov, A., Ed., Leiba, B., Ed., Segmuller, W., and T. 464 Martin, "Sieve Email Filtering: Extension for 465 Notifications", RFC 5435, DOI 10.17487/RFC5435, January 466 2009, . 468 [RFC5490] Melnikov, A., "The Sieve Mail-Filtering Language -- 469 Extensions for Checking Mailbox Status and Accessing 470 Mailbox Metadata", RFC 5490, DOI 10.17487/RFC5490, March 471 2009, . 473 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 474 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 475 May 2017, . 477 8.2. Informative References 479 [RFC5321] Klensin, J., "Simple Mail Transfer Protocol", RFC 5321, 480 DOI 10.17487/RFC5321, October 2008, 481 . 483 [RFC5429] Stone, A., Ed., "Sieve Email Filtering: Reject and 484 Extended Reject Extensions", RFC 5429, 485 DOI 10.17487/RFC5429, March 2009, 486 . 488 [RFC5436] Leiba, B. and M. Haardt, "Sieve Notification Mechanism: 489 mailto", RFC 5436, DOI 10.17487/RFC5436, January 2009, 490 . 492 [RFC5437] Saint-Andre, P. and A. Melnikov, "Sieve Notification 493 Mechanism: Extensible Messaging and Presence Protocol 494 (XMPP)", RFC 5437, DOI 10.17487/RFC5437, January 2009, 495 . 497 [RFC6131] George, R. and B. Leiba, "Sieve Vacation Extension: 498 "Seconds" Parameter", RFC 6131, DOI 10.17487/RFC6131, July 499 2011, . 501 [RFC7942] Sheffer, Y. and A. Farrel, "Improving Awareness of Running 502 Code: The Implementation Status Section", BCP 205, 503 RFC 7942, DOI 10.17487/RFC7942, July 2016, 504 . 506 8.3. URIs 508 [1] https://tools.ietf.org/html/bcp14 510 [2] http://www.cyrusimap.org/ 512 [3] http://www.cmu.edu/computing/ 514 Appendix A. Change History (To be removed by RFC Editor before 515 publication) 517 Changes since draft-ietf-extra-sieve-fcc-03: 519 o Fixed typo in ABNF. 521 Changes since draft-ietf-extra-sieve-fcc-02: 523 o Updated Keywords boilerplate. 525 o Noted that :fcc mailbox argument and any fileinto extension 526 arguments used wth :fcc have the same syntax and semantics as they 527 have with fileinto. 529 o Removed section on [e]Reject. 531 o Added "fcc" notification-capability. 533 o Added Implementation Status section. 535 o Editorial changes from Ned Freed. 537 Changes since draft-ietf-extra-sieve-fcc-01: 539 o Added text discussing how to handle generated messages that are 540 not in MIME format. 542 o Adjusted ABNF so that tagged arguments that supplement :fcc no 543 longer appear as positional. 545 Changes since draft-ietf-extra-sieve-fcc-00: 547 o Updated abstract with text from Ned. 549 o Added support for :fcc to notify extension. 551 o Prohibit use of :fcc with reject and ereject extensions. 553 o Added registration of the extension with IANA. 555 o Added Acknowledgments. 557 o Minor editorial changes. 559 Authors' Addresses 561 Kenneth Murchison 562 FastMail US LLC 563 1315 Walnut Street - Suite 320 564 Philadelphia, PA 19107 565 USA 567 Email: murch@fastmailteam.com 569 Bron Gondwana 570 FastMail Pty Ltd 571 Level 2, 114 William Street 572 Melbourne, VIC 3000 573 Australia 575 Email: brong@fastmailteam.com