idnits 2.17.1 draft-daboo-sieve-include-02.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 3667, Section 5.1 on line 13. -- Found old boilerplate from RFC 3978, Section 5.5 on line 376. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 353. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 360. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 366. ** Found boilerplate matching RFC 3978, Section 5.4, paragraph 1 (on line 382), which is fine, but *also* found old RFC 2026, Section 10.4C, paragraph 1 text on line 35. ** The document seems to lack an RFC 3978 Section 5.1 IPR Disclosure Acknowledgement -- however, there's a paragraph with a matching beginning. Boilerplate error? ** 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. ** The document uses RFC 3667 boilerplate or RFC 3978-like boilerplate instead of verbatim RFC 3978 boilerplate. After 6 May 2005, submission of drafts without verbatim RFC 3978 boilerplate is not accepted. The following non-3978 patterns matched text found in the document. That text should be removed or replaced: By submitting this Internet-Draft, I certify that any applicable patent or other IPR claims of which I am aware have been disclosed, or will be disclosed, and any of which I become aware will be disclosed, in accordance with RFC 3668. 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 9 longer pages, the longest (page 7) being 71 lines == It seems as if not all pages are separated by form feeds - found 0 form feeds but 9 pages Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There are 4 instances of too long lines in the document, the longest one being 3 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 the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. (The document does seem to have the reference to RFC 2119 which the ID-Checklist requires). -- 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 (July 17, 2004) is 7222 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: 'LOCATION' is mentioned on line 144, but not defined ** Obsolete normative reference: RFC 3028 (Obsoleted by RFC 5228, RFC 5429) Summary: 8 errors (**), 0 flaws (~~), 6 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Network Working Group C. Daboo 2 Internet-Draft ISAMET, Inc. 3 Expires: January 15, 2005 July 17, 2004 5 SIEVE Email Filtering: Include Extension 6 draft-daboo-sieve-include-02 8 Status of this Memo 10 By submitting this Internet-Draft, I certify that any applicable 11 patent or other IPR claims of which I am aware have been disclosed, 12 and any of which I become aware will be disclosed, in accordance with 13 RFC 3668. 15 Internet-Drafts are working documents of the Internet Engineering 16 Task Force (IETF), its areas, and its working groups. Note that 17 other groups may also distribute working documents as 18 Internet-Drafts. 20 Internet-Drafts are draft documents valid for a maximum of six months 21 and may be updated, replaced, or obsoleted by other documents at any 22 time. It is inappropriate to use Internet-Drafts as reference 23 material or to cite them other than as "work in progress." 25 The list of current Internet-Drafts can be accessed at 26 http://www.ietf.org/ietf/1id-abstracts.txt. 28 The list of Internet-Draft Shadow Directories can be accessed at 29 http://www.ietf.org/shadow.html. 31 This Internet-Draft will expire on January 15, 2005. 33 Copyright Notice 35 Copyright (C) The Internet Society (2004). All Rights Reserved. 37 Abstract 39 The SIEVE Email Filtering "include" extension permits users to 40 include one SIEVE script inside another. This can make managing 41 large scripts or multiple sets of scripts much easier, as well as 42 supporting common 'libraries' of scripts. Users are able to include 43 their own personal scripts or site-wide scripts provided by the local 44 SIEVE implementation. 46 Change History (to be removed prior to publication as an RFC) 48 Changes from -01 to -02: 50 a. Minor formatting changes only - refreshing expired draft. 52 Changes from -00 to -01: 53 a. Added IPR boiler plate. 54 b. Re-ordered sections at start to conform to RFC style. 55 c. Moved recursion comment into General Considerations section. 56 d. Switched to using optional parameter to indicate personal vs 57 global. 58 e. Explicitly state that an error occurs when a missing script is 59 included. 61 Table of Contents 63 1. Introduction and Overview . . . . . . . . . . . . . . . . . . 3 64 2. Conventions Used in This Document . . . . . . . . . . . . . . 3 65 3. SIEVE Include Extension . . . . . . . . . . . . . . . . . . . 3 66 3.1 General Considerations . . . . . . . . . . . . . . . . . . 3 67 3.2 Control Structure Include . . . . . . . . . . . . . . . . 4 68 3.3 Control Structure Return . . . . . . . . . . . . . . . . . 7 69 4. Security Considerations . . . . . . . . . . . . . . . . . . . 7 70 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7 71 5.1 include registration . . . . . . . . . . . . . . . . . . . 7 72 6. Normative References . . . . . . . . . . . . . . . . . . . . . 8 73 Author's Address . . . . . . . . . . . . . . . . . . . . . . . 8 74 A. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 8 75 Intellectual Property and Copyright Statements . . . . . . . . 9 77 1. Introduction and Overview 79 Its convenient to be able to break SIEVE [RFC3028] scripts down into 80 smaller components which can be reused in a variety of different 81 circumstances. For example, users may want to have a default script 82 and a special 'vacation' script, the later being activated when the 83 user goes on vacation. In that case the default actions should 84 continue to be run, but a vacation command should be executed first. 85 One option is to edit the default script to add or remove the 86 vacation command as needed. Another is to have a vacation script 87 that simply has a vacation command and then includes the default 88 script. 90 2. Conventions Used in This Document 92 Conventions for notations are as in [RFC3028] section 1.1, including 93 use of [RFC2119]. 95 3. SIEVE Include Extension 97 3.1 General Considerations 99 SIEVE implementations that implement the "include" and "return" 100 control structures described below have an identifier of "include" 101 for use with the capability mechanism. If either of the "include" or 102 "return" control structures are used in a script, the "include" 103 capability MUST be listed in the "require" statement in that script. 105 SIEVE implementations must track the use of actions in included 106 scripts so that implicit "keep" behaviour can be properly determined 107 based on whether any actions have executed in any script. 109 SIEVE implementations are allowed to limit the total number of nested 110 included scripts, but MUST provide for a total of at least three 111 levels of nested scripts including the top-level script. An error 112 MUST be generated either when the script is uploaded to the SIEVE 113 repository, or when the script is executed, if any nesting limit is 114 exceeded. If such an error is detected whilst processing a SIEVE 115 script, an implicit "keep" action MUST be executed to prevent loss of 116 any messages. 118 SIEVE implementations MUST ensure that recursive includes are not 119 possible. i.e. if script "A" includes script "B", and script "B" 120 includes script "A" an error MUST be generated either when the script 121 is uploaded to the SIEVE repository, or when the script is executed. 122 If such an error is detected whilst processing a SIEVE script, an 123 implicit "keep" action MUST be executed to prevent loss of any 124 messages. 126 SIEVE implementations MUST handle missing scripts being referenced 127 via an includes in an existing script. An error MUST be generated 128 when a missing included script is descovered during execution. If 129 such an error is detected an implicit "keep" action MUST be executed 130 to prevent loss of any messages. 132 3.2 Control Structure Include 134 Syntax: include [LOCATION] 136 The "include" control structure includes an optional parameter, and a 137 single string argument representing the name of the script to include 138 in the main script at that point. 140 [LOCATION] is an optional parameter that has one of two values: 142 Syntax: ":personal" / ":global" 144 If the [LOCATION] parameter is not present, the location defaults to 145 :personal. 147 The location has the following meanings: 149 :personal 151 Indicates that the named script is stored in the user's own 152 personal (private) SIEVE repository. 154 :global 156 Indicates that the named script is stored in a site-wide SIEVE 157 repository, accessible to all users of the SIEVE system. 159 The included script MUST be a valid SIEVE script, including having 160 necessary "require" statements for all optional capabilities used by 161 the script. The scope of a "require" statement in an included script 162 is for that script only, not the including script. e.g. if script 163 "A" includes script "B", and script "B" uses the "fileinto" 164 extension, script "B" must have a "require" statement for "fileinto", 165 irrespective of whether script "A" has one. In addition, if script 166 "A" does not have a "require" statement for "fileinto", "fileinto" 167 cannot be used anywhere in script "A", even after inclusion of script 168 "B". 170 A "stop" control statement in an included script MUST stop all script 171 processing, including the processing of the scripts that include the 172 current one. The "return" control statement (described below) stops 173 processing of the current script only, and allows the scripts that 174 include it to continue. 176 Examples: 178 In the examples below, script content is indicated by a '|' as the 179 first non-space character on a line for clarity. The '|' characters 180 are not part of the script itself. 182 The user has four scripts stored in their personal repository: 184 "default" 186 This is the default active script that includes several others. 188 | require ["include"]; 189 | 190 | include :personal "always_allow"; 191 | include :global "spam_tests"; 192 | include :personal "my_spam_tests"; 193 | include :personal "mailing_lists"; 195 "always_allow" 197 This script special cases some correspondent email addresses and 198 makes sure any message containing those addresses are always kept. 200 | if header :is "From" "boss@example.com" 201 | { 202 | keep; 203 | } 204 | elsif header :is "From" "ceo@example.com" 205 | { 206 | keep; 207 | } 209 "my_spam_tests" 211 This script does some user-specific spam tests to catch spam 212 messages not caught by the site-wide spam tests. 214 | require ["reject"]; 215 | 216 | if header :contains "Subject" "XXXX" 217 | { 218 | reject; 219 | } 220 | elsif header :is "From" "money@example.com" 221 | { 222 | reject; 223 | } 225 "mailing_lists" 227 This script looks for messages from different mailing lists and 228 files each into a mailbox specific to the mailing list. 230 | require ["fileinto"]; 231 | 232 | if header :is "Sender" "owner-ietf-mta-filters@imc.org" 233 | { 234 | fileinto "lists.sieve"; 235 | } 236 | elsif header :is "Sender" "owner-ietf-imapext@imc.org" 237 | { 238 | fileinto "lists.imapext"; 239 | } 241 There is one script stored in the global repository: 243 "spam_tests" 245 This script does some site-wide spam tests which any user at the 246 site can include in their own scripts at a suitable point. The 247 script content is kept up to date by the site administrator. 249 | require ["reject"]; 250 | 251 | if anyof (header :contains "Subject" "$$", 252 | header :contains "Subject" "Make money") 253 | { 254 | reject; 255 | } 257 The "include" control structure may appear anywhere in the script 258 where a control structure is legal. 260 Example: 262 | require ["include"]; 263 | 264 | if anyof (header :contains "Subject" "$$", 265 | header :contains "Subject" "Make money") 266 | { 267 | include "my_reject_script"; 268 | } 270 3.3 Control Structure Return 272 Syntax: return 274 The "return" control structure stops processing of the currently 275 included script only and returns processing control to the script 276 which includes it. If used in the main script (i.e. not in an 277 included script), it has the same effect as the "stop" control 278 structure, including the appropriate "keep" action if no other 279 actions have been executed up to that point. 281 4. Security Considerations 283 SIEVE implementations MUST ensure adequate security for the global 284 script repository to prevent unauthorized changes to global scripts. 286 Beyond that, the "include" extension does not raise any security 287 considerations that are not present in the base SIEVE protocol, and 288 these issues are discussed in SIEVE. 290 5. IANA Considerations 292 The following template specifies the IANA registration of the Sieve 293 extension specified in this document: 295 5.1 include registration 297 To: iana@iana.org 298 Subject: Registration of new Sieve extension 300 Capability name: include 301 Capability keyword: include 302 Capability arguments: N/A 303 Standards Track/IESG-approved experimental RFC number: this RFC 304 Person and email address to contact for further information: 306 Cyrus Daboo 307 ISAMET, Inc. 308 5001 Baum Blvd., Suite 650, 309 Pittsburgh, PA 15213 310 U.S.A. 312 314 This information should be added to the list of sieve extensions 315 given on http://www.iana.org/assignments/sieve-extensions. 317 This information should be added to the list of sieve extensions 318 given on http://www.iana.org/assignments/sieve-extensions. 320 6 Normative References 322 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 323 Requirement Levels", BCP 14, RFC 2119, March 1997. 325 [RFC3028] Showalter, T., "Sieve: A Mail Filtering Language", RFC 326 3028, January 2001. 328 Author's Address 330 Cyrus Daboo 331 ISAMET, Inc. 332 5001 Baum Blvd. 333 Suite 650 334 Pittsburgh, PA 15213 335 US 337 EMail: daboo@isamet.com 339 Appendix A. Acknowledgments 341 Thanks to Ken Murchison, Rob Siemborski, Alexey Melnikov, Marc Mutz 342 and Kjetil Torgrim Homme for comments and corrections. 344 Intellectual Property Statement 346 The IETF takes no position regarding the validity or scope of any 347 Intellectual Property Rights or other rights that might be claimed to 348 pertain to the implementation or use of the technology described in 349 this document or the extent to which any license under such rights 350 might or might not be available; nor does it represent that it has 351 made any independent effort to identify any such rights. Information 352 on the procedures with respect to rights in RFC documents can be 353 found in BCP 78 and BCP 79. 355 Copies of IPR disclosures made to the IETF Secretariat and any 356 assurances of licenses to be made available, or the result of an 357 attempt made to obtain a general license or permission for the use of 358 such proprietary rights by implementers or users of this 359 specification can be obtained from the IETF on-line IPR repository at 360 http://www.ietf.org/ipr. 362 The IETF invites any interested party to bring to its attention any 363 copyrights, patents or patent applications, or other proprietary 364 rights that may cover technology that may be required to implement 365 this standard. Please address the information to the IETF at 366 ietf-ipr@ietf.org. 368 Disclaimer of Validity 370 This document and the information contained herein are provided on an 371 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 372 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 373 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 374 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 375 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 376 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 378 Copyright Statement 380 Copyright (C) The Internet Society (2004). This document is subject 381 to the rights, licenses and restrictions contained in BCP 78, and 382 except as set forth therein, the authors retain all their rights. 384 Acknowledgment 386 Funding for the RFC Editor function is currently provided by the 387 Internet Society.