draft-freed-sieve-notary-02.txt   draft-freed-sieve-notary-03.txt 
Network Working Group N. Freed Network Working Group N. Freed
Internet-Draft Sun Microsystems Internet-Draft Sun Microsystems
Expires: May 21, 2009 November 17, 2008 Expires: July 19, 2009 January 15, 2009
Sieve Email Filtering: Delivery Status Notifications Extension Sieve Email Filtering: Delivery Status Notifications Extension
draft-freed-sieve-notary-02 draft-freed-sieve-notary-03
Status of this Memo Status of this Memo
By submitting this Internet-Draft, each author represents that any This Internet-Draft is submitted to IETF in full conformance with the
applicable patent or other IPR claims of which he or she is aware provisions of BCP 78 and BCP 79.
have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as Internet- other groups may also distribute working documents as Internet-
Drafts. Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt. http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
This Internet-Draft will expire on May 21, 2009. This Internet-Draft will expire on July 19, 2009.
Copyright Notice
Copyright (c) 2009 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document.
Abstract Abstract
This document describes the "dsn-envelope" and "dsn-redirect" This document describes the "envelope-dsn" and "redirect-dsn"
extensions to the Sieve email filtering language. The "dsn-envelope" extensions to the Sieve email filtering language. The "envelope-dsn"
extension provides access to additional envelope information provided extension provides access to additional envelope information provided
by the delivery status notification extension to SMTP defined in RFC by the delivery status notification extension to SMTP defined in RFC
3461. The "dsn-redirect" extension extends Sieve's redirect action 3461. The "redirect-dsn" extension extends Sieve's redirect action
to provide control over delivery status notification parameters. to provide control over delivery status notification parameters.
Change History (to be removed prior to publication as an RFC Change History (to be removed prior to publication as an RFC
Fixed several typos. Fixed several typos.
Changed name of extension from notary to dsn-envelope. Changed name of extension from notary to envelope-dsn.
Added the dsn-redirect extension. Added the redirect-dsn extension.
Updated references. Updated references.
Added a note about the use of ADDRESS-PART arguments with the new Added a note about the use of ADDRESS-PART arguments with the new
envelope-part strings defined by the dsn-envelope extension. envelope-part strings defined by the envelope-dsn extension.
Fleshed out the dsn-redirect extension. Fleshed out the redirect-dsn extension.
Changed document title to agree with new extension names. Changed document title to agree with new extension names.
Added some examples. Added some examples.
Fixed more typos. Fixed more typos.
Changed dsn-envelope and dsn-redirect to envelope-dsn and redirect-
dsn, respectively.
Added a redirect-dsn example.
1. Introduction 1. Introduction
Sieve [RFC5228] is a language for filtering email messages at or Sieve [RFC5228] is a language for filtering email messages at or
around the time of final delivery. It is designed to be around the time of final delivery. It is designed to be
implementable on either a mail client or mail server. It is suitable implementable on either a mail client or mail server. It is suitable
for running on a mail server where users may not be allowed to for running on a mail server where users may not be allowed to
execute arbitrary programs, such as on black box Internet Message execute arbitrary programs, such as on black box Internet Message
Access Protocol [RFC3501] servers, as it has no user-controlled loops Access Protocol [RFC3501] servers, as it has no user-controlled loops
or the ability to run external programs. or the ability to run external programs.
The base sieve specification defines the envelope extension and test The base sieve specification defines the envelope extension and test
to access information in the message envelope. Only information to access information in the message envelope. Only information
available in regular SMTP is provided; additional information added available in regular SMTP is provided; additional information added
to the SMTP envelope by SMTP extensions cannot be accessed. The to the SMTP envelope by SMTP extensions cannot be accessed. The
"dsn-envelope" extension extends the envelope test to allow access to "envelope-dsn" extension extends the envelope test to allow access to
the additional envelope fields defined by the SMTP extension for the additional envelope fields defined by the SMTP extension for
delivery status notification specified in RFC 3461 [RFC3461]. delivery status notification specified in RFC 3461 [RFC3461].
The base sieve specification also defines the redirect action which The base sieve specification also defines the redirect action which
sends the message to a different address. Redirect only allows sends the message to a different address. Redirect only allows
specification of the new recipient address. The "dsn-redirect" specification of the new recipient address. The "redirect-dsn"
extension extends redirect to allow specification of some fields extension extends redirect to allow specification of some fields
defined by the delivery status notification SMTP extension. defined by the delivery status notification SMTP extension.
2. Conventions used in this document 2. Conventions used in this document
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
The terms used to describe the various components of the Sieve The terms used to describe the various components of the Sieve
language are taken from Section 1.1 of [RFC5228]. language are taken from Section 1.1 of [RFC5228].
This document uses the ABNF notation specified in [RFC5234] and This document uses the ABNF notation specified in [RFC5234] and
refers to the ABNF production notify-esmtp-value defined in Section refers to the ABNF production notify-esmtp-value defined in Section
4.1 of [RFC3461]. 4.1 of [RFC3461].
3. Capability Identifier 3. Capability Identifier
The capability strings associated with the extensions defined in this The capability strings associated with the extensions defined in this
document are "dsn-envelope" and "dsn-redirect". document are "envelope-dsn" and "redirect-dsn".
4. Dsn-envelope extension 4. envelope-dsn extension
The "dsn-envelope" extension does not define any new tests or The "envelope-dsn" extension does not define any new tests or
actions, rather, it adds four values to the list of possible (case- actions, rather, it adds four values to the list of possible (case-
insensitive) envelope-part strings defined in Section 5.4 of insensitive) envelope-part strings defined in Section 5.4 of
[RFC5228]: [RFC5228]:
notify Match the list of notification conditions, or NOTIFY values, notify Match the list of notification conditions, or NOTIFY values,
associated with TO address used in the SMTP RCPT TO command that associated with TO address used in the SMTP RCPT TO command that
resulted in this message getting delivered to this user. More resulted in this message getting delivered to this user. More
than one notification condition can be in effect at once; each than one notification condition can be in effect at once; each
condition that is in effect is tested separately and any match condition that is in effect is tested separately and any match
causes the text to succeed. The syntax and semantics of the causes the text to succeed. The syntax and semantics of the
skipping to change at page 4, line 23 skipping to change at page 4, line 41
":count". The count of an envelope test of with an envelope-part of ":count". The count of an envelope test of with an envelope-part of
"orcpt", "ret", and "envid" is 1 if the corresponding SMTP parameter "orcpt", "ret", and "envid" is 1 if the corresponding SMTP parameter
is present and 0 otherwise. The count of an envelope test with an is present and 0 otherwise. The count of an envelope test with an
envelope-part of "notify" is equal to the number of notification envelope-part of "notify" is equal to the number of notification
conditions specified and 0 if the NOTIFY parameter is not present. conditions specified and 0 if the NOTIFY parameter is not present.
4.1. Examples 4.1. Examples
The fact that the notify envelope-part operates on a list of values The fact that the notify envelope-part operates on a list of values
makes it easy to check to see if a given value is present without makes it easy to check to see if a given value is present without
havingt to worry about other values: having to worry about other values:
require ["envelope", "dsn-envelope"]; require ["envelope", "envelope-dsn"];
# Check whether SUCCESS notifications were requested, # Check whether SUCCESS notifications were requested,
# irrespective of any other requests that were made # irrespective of any other requests that were made
if envelope "notify" "SUCCESS" if envelope "notify" "SUCCESS"
{ {
# do whatever # do whatever
} }
Checking to see if a given request is the only one present is a Checking to see if a given request is the only one present is a
little trickier, however: little trickier, however:
require ["envelope", "dsn-envelope", "relational", require ["envelope", "envelope-dsn", "relational",
"comparator-i;ascii-numeric"]; "comparator-i;ascii-numeric"];
# Check whether only FAILURE notifications were requested # Check whether only FAILURE notifications were requested
if allof ( envelope "notify" "FAILURE", if allof ( envelope "notify" "FAILURE",
envelope :comparator "i;ascii-numeric" envelope :comparator "i;ascii-numeric"
:count "eq" "notify" "1" :count "eq" "notify" "1"
) )
{ {
# do whatever # do whatever
} }
The orcpt envelope-part contains an address type indicator in The orcpt envelope-part contains an address type indicator in
addition to an address, which must be taken into account: addition to an address, which must be taken into account:
require ["envelope", "dsn-envelope"]; require ["envelope", "envelope-dsn"];
# See if the orcpt is an RFC822 address in the example.com # See if the orcpt is an RFC822 address in the example.com
# domain # domain
if envelope :matches "orcpt" "rfc822;*@example.com" if envelope :matches "orcpt" "rfc822;*@example.com"
{ {
# do whatever # do whatever
} }
5. Dsn-redirect extension 5. redirect-dsn extension
The "dsn-redirect" extension does not define any new tests or The "redirect-dsn" extension does not define any new tests or
actions, rather, it adds two new arguments, NOTIFY and RET, to the actions, rather, it adds two new arguments, NOTIFY and RET, to the
redirect action defined in Section 4.2 of [RFC5228]. This updates redirect action defined in Section 4.2 of [RFC5228]. This updates
the usage description for redirect to: the usage description for redirect to:
Usage: redirect [NOTIFY] [RET] <address: string> Usage: redirect [NOTIFY] [RET] <address: string>
The syntax for the NOTIFY and RET arguments are: The syntax for the NOTIFY and RET arguments are:
NOTIFY = ":notify" notify-value NOTIFY = ":notify" notify-value
notify-value = DQUOTE notify-esmtp-value DQUOTE notify-value = DQUOTE notify-esmtp-value DQUOTE
skipping to change at page 5, line 41 skipping to change at page 6, line 10
The notify-esmtp-value production is defined in Section 4.1 of The notify-esmtp-value production is defined in Section 4.1 of
[RFC3461]. [RFC3461].
When these arguments are specified, they set the corresponding NOTIFY When these arguments are specified, they set the corresponding NOTIFY
ESMTP RCPT TO and RET ESMTP MAIL FROM parameters, respectively. ESMTP RCPT TO and RET ESMTP MAIL FROM parameters, respectively.
These parameters are only available when the delivery status These parameters are only available when the delivery status
notification (DSN) ESMTP extension is available; they are simply notification (DSN) ESMTP extension is available; they are simply
ignored and MUST NOT cause an error if the DSN extension is ignored and MUST NOT cause an error if the DSN extension is
unavailable. unavailable.
5.1. Example
One possible use of :notify on redirect is to ccmbine the copy
extension [RFC3894] with the ability to suppress nondelivery
notifications to generate a private copy of selected messages with no
side effects or error notifications:
require ["copy", "redirect-dsn"];
# Make a private copy of messages from user@example.com
if address "from" "user@example.com"
{
redirect :copy :notify "NEVER" "elsewhere@example.com";
}
6. Security Considerations 6. Security Considerations
The dsn-envelope extension provides access to additional message The envelope-dsn extension provides access to additional message
envelope information. This is not believed to raise any additional envelope information. This is not believed to raise any additional
security issues beyond those for the Sieve "envelope" test. security issues beyond those for the Sieve "envelope" test.
The dsn-redirect extension allows specification of the delivery The redirect-dsn extension allows specification of the delivery
status notification's NOTIFY parameter which can cause the generation status notification's NOTIFY parameter which can cause the generation
of notification messages that might otherwise not be generated, of notification messages that might otherwise not be generated,
especially if notification in the event of successful delivery is especially if notification in the event of successful delivery is
required. Sites which limit the ability to request success required. Sites which limit the ability to request success
notifications will also need to restrict the ability to request them notifications will also need to restrict the ability to request them
using the dsn-redirect extension. using the redirect-dsn extension.
All of the security considerations given in the base Sieve All of the security considerations given in the base Sieve
specification also apply to this extension. specification also apply to this extension.
7. IANA Considerations 7. IANA Considerations
The following template specifies the IANA registration of the Sieve The following template specifies the IANA registration of the Sieve
extension specified in this document: extension specified in this document:
To: iana@iana.org To: iana@iana.org
Subject: Registration of new Sieve extensions Subject: Registration of new Sieve extensions
Capability name: dsn-envelope Capability name: envelope-dsn
Description: The "dsn-envelope" extension extends the envelope Description: The "envelope-dsn" extension extends the envelope
test to allow checking of information associated test to allow checking of information associated
with the DSN ESMTP extension defined in RFC 3461. with the DSN ESMTP extension defined in RFC 3461.
RFC number: RFC XXXX RFC number: RFC XXXX
Contact address: Sieve discussion list <ietf-mta-filters@imc.org> Contact address: Sieve discussion list <ietf-mta-filters@imc.org>
Capability name: dsn-redirect Capability name: redirect-dsn
Description: The "dsn-redirect" extension extends the redirect Description: The "redirect-dsn" extension extends the redirect
action to allow specification of the NOTIFY and action to allow specification of the NOTIFY and
RET ESMTP parameters associated with the DSN SMTP RET ESMTP parameters associated with the DSN SMTP
extension defined in RFC 3461. extension defined in RFC 3461.
RFC number: RFC XXXX RFC number: RFC XXXX
Contact address: Sieve discussion list <ietf-mta-filters@imc.org> Contact address: Sieve discussion list <ietf-mta-filters@imc.org>
This information should be added to the list of sieve extensions This information should be added to the list of sieve extensions
given on http://www.iana.org/assignments/sieve-extensions. given on http://www.iana.org/assignments/sieve-extensions.
8. References 8. References
skipping to change at page 7, line 16 skipping to change at page 8, line 10
Relational Extension", RFC 5231, January 2008. Relational Extension", RFC 5231, January 2008.
[RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax [RFC5234] Crocker, D. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, RFC 5234, January 2008. Specifications: ABNF", STD 68, RFC 5234, January 2008.
8.2. Informative references 8.2. Informative references
[RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION [RFC3501] Crispin, M., "INTERNET MESSAGE ACCESS PROTOCOL - VERSION
4rev1", RFC 3501, March 2003. 4rev1", RFC 3501, March 2003.
[RFC3894] Degener, J., "Sieve Extension: Copying Without Side
Effects", RFC 3894, October 2004.
Appendix A. Acknowledgements Appendix A. Acknowledgements
Cyrus Daboo, Derek Diget, Philip Guenther, Arnt Gulbrandsen, Alexey Cyrus Daboo, Derek Diget, Philip Guenther, Arnt Gulbrandsen, Alexey
Melnikov, and Alexandros Vellis provided helpful suggestions and Melnikov, and Alexandros Vellis provided helpful suggestions and
corrections. corrections.
Author's Address Author's Address
Ned Freed Ned Freed
Sun Microsystems Sun Microsystems
800 Royal Oaks 800 Royal Oaks
Monrovia, CA 91016-6347 Monrovia, CA 91016-6347
USA USA
Phone: +1 909 457 4293 Phone: +1 909 457 4293
Email: ned.freed@mrochek.com Email: ned.freed@mrochek.com
Full Copyright Statement
Copyright (C) The IETF Trust (2008).
This document is subject to the rights, licenses and restrictions
contained in BCP 78, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND
THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF
THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
 End of changes. 30 change blocks. 
32 lines changed or deleted 65 lines changed or added

This html diff was produced by rfcdiff 1.35. The latest version is available from http://tools.ietf.org/tools/rfcdiff/