Sieve Email Filtering: Notary Extension
draft-freed-sieve-notary-01

Status of this Memo

By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware 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 Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress.”

The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt.

The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html.

This Internet-Draft will expire on February 1, 2009.

Abstract

This document describes the "dsn-envelope" and "dsn-redirect" extensions to the Sieve email filtering language. The "dsn-envelope" extension provides access to additional envelope information provided by the delivery status notification extension to SMTP defined in RFC 3461. The "dsn-redirect" extension extends Sieve's redirect action to provide control over delivery status notification parameters.

Change History (to be removed prior to publication as an RFC

Fixed several typos.

Changed name of extension from notary to dsn-envelope.

Added the dsn-redirect extension.

Updated references.

Added a note about the use of ADDRESS-PART arguments with the new envelope-part strings defined by the dsn-envelope extension.

Fleshed out the dsn-redirect extension.

1.  Introduction

Sieve [RFC5228] (Guenther, P. and T. Showalter, “Sieve: An Email Filtering Language,” January 2008.) is a language for filtering email messages at or around the time of final delivery. It is designed to be 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 execute arbitrary programs, such as on black box Internet Message Access Protocol [RFC3501] (Crispin, M., “INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1,” March 2003.) servers, as it has no user-controlled loops or the ability to run external programs.

The base sieve specification defines the envelope extension and test to access information in the message envelope. Only information available in regular SMTP is provided; additional information added to the SMTP envelope by SMTP extensions cannot be accessed. The "dsn-envelope" extension extends the envelope test to allow access to the additional envelope fields defined by the SMTP extension for delivery status notification specified in RFC 3461 (Moore, K., “Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs),” January 2003.) [RFC3461].

The base sieve specification also defines the redirect action which sends the message to a different address. Redirect only allows specification of the new recipient address. The "dsn-redirect" extension extends redirect to allow specification of some fields defined by the delivery status notification SMTP extension.

2.  Conventions used in this document

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 (Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” March 1997.) [RFC2119].

The terms used to describe the various components of the Sieve language are taken from Section 1.1 of [RFC5228] (Guenther, P. and T. Showalter, “Sieve: An Email Filtering Language,” January 2008.).

This document uses the ABNF notation specified in [RFC5234] (Crocker, D. and P. Overell, “Augmented BNF for Syntax Specifications: ABNF,” January 2008.) and refers to the ABNF production notify-esmtp-value defined in Section 4.1 of [RFC3461] (Moore, K., “Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs),” January 2003.).

3.  Capability Identifier

The capability strings associated with the extensions defined in this document are "dsn-envelope" and "dsn-redirect".

4.  Dsn-envelope extension

The "dsn-envelope" extension does not define any new tests or actions, rather, it adds four values to the list of possible (case-insensitive) envelope-part strings defined in Section 5.4 of [RFC5228] (Guenther, P. and T. Showalter, “Sieve: An Email Filtering Language,” January 2008.):

notify

Match the list of notification conditions, or NOTIFY values, associated with TO address used in the SMTP RCPT TO command that resulted in this message getting delivered to this user. More than one notification condition can be in effect at once; each condition that is in effect is tested separately and any match causes the text to succeed. The syntax and semantics of the NOTIFY parameter are defined in RFC 3461 (Moore, K., “Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs),” January 2003.) [RFC3461] section 4.1. Currently the possible notification condition values are "NEVER", "SUCCESS", "FAILURE" and "DELAY". Note that the value "NEVER" cannot be combined with any other value.

orcpt

Match the original recipient, or ORCPT, value in decoded form associated with the TO address used in the SMTP RCPT TO command that resulted in this message getting delivered to this user. The syntax and semantics of the ORCPT parameter are defined in Section 2.2 of RFC 3461 (Moore, K., “Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs),” January 2003.) [RFC3461].

ret

Match the return of content, or RET, value given in the SMTP MAIL FROM command. The syntax and semantics of the RET parameter are defined in RFC 3461 (Moore, K., “Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs),” January 2003.) [RFC3461] section 4.3. Currently the possible return of content values are "FULL" and "HDRS".

envid

Match the envelope identifier, or ENVID, value in decoded form given in the SMTP MAIL FROM command. The syntax and semantics of the ENVID parameter are defined in Section 4.4 of RFC 3461 (Moore, K., “Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs),” January 2003.) [RFC3461].

All of these tests fail unconditionally if the specified envelope parameter does not exist for the current message or recipient.

The envelope test's ADDRESS-PART argument assumes the string being tested has the syntax of an email address. None of the new envelope parts defined here have address syntax, accordingly, it is an error to specify an ADDRESS-PART argument in conjunction with these new envelope parts.

The "relational" extension [RFC5231] (Segmuller, W. and B. Leiba, “Sieve Email Filtering: Relational Extension,” January 2008.) adds a match type called ":count". The count of an envelope test of with an envelope-part of "orcpt", "ret", and "envid" is 1 if the corresponding SMTP parameter is present and 0 otherwise. The count of an envelope test with an envelope-part of "notify" is equal to the number of notification conditions specified and 0 if the NOTIFY parameter is not present.

5.  Dsn-redirect extension

The "dsn-redirect" extension does not define any new tests or actions, rather, it adds two new arguments, NOTIFY and RET, to the redirect action defined in Section 4.2 of [RFC5228] (Guenther, P. and T. Showalter, “Sieve: An Email Filtering Language,” January 2008.). This updates the usage description for redirect to:

Usage:   redirect [NOTIFY] [RET] <address: string>

The syntax for the NOTIFY and RET arguments are:

NOTIFY = ":notify" notify-value
notify-value = DQUOTE notify-esmtp-value DQUOTE

RET = ":ret" ret-value
ret-value = DQUOTE ("FULL" / "HDRS") DQUOTE

The notify-esmtp-value production is defined in Section 4.1 of [RFC3461] (Moore, K., “Simple Mail Transfer Protocol (SMTP) Service Extension for Delivery Status Notifications (DSNs),” January 2003.).

When these arguments are specified, they set the corresponding NOTIFY ESMTP RCPT TO and RET ESMTP MAIL FROM parameters, respectively. These parameters are only available when the delivery status notification (DSN) ESMTP extension is available; they are simply ignored and MUST NOT cause an error if the DSN extension is unavailable.

6.  Security Considerations

The dsn-envelope extension provides access to additional message envelope information. This is not believed to raise any additional security issues beyond those for the Sieve "envelope" test.

The dsn-redirect extension allows specification of the delivery status notification's NOTIFY parameter which can cause the generation of notification messages that might otherwise not be generated, especially if notification in the event of successful delivery is required. Sites which limit the ability to request success notifications will also need to restrict the ability to request then using the dsn-redirect extension.

All of the security considerations given in the base Sieve specification also apply to this extension.

7.  IANA Considerations

The following template specifies the IANA registration of the Sieve extension specified in this document:

   To: iana@iana.org
   Subject: Registration of new Sieve extensions

   Capability name: dsn-envelope
   Description:     The "dsn-envelope" extension extends the envelope
                    test to allow checking of information associated
                    with the DSN ESMTP extension defined in RFC 3461.
   RFC number:      RFC XXXX
   Contact address: Sieve discussion list <ietf-mta-filters@imc.org>

   Capability name: dsn-envelope
   Description:     The "dsn-redirect" extension extends the redirect
                    action to allow specification of the NOTIFY and
                    RET ESMTP parameters associated with the DSN SMTP
                    extension defined in RFC 3461.
   RFC number:      RFC XXXX
   Contact address: Sieve discussion list <ietf-mta-filters@imc.org>

   This information should be added to the list of sieve extensions
   given on http://www.iana.org/assignments/sieve-extensions.

8.  References

8.1. Normative references

8.2. Informative references

Author's Address

Full Copyright Statement

Copyright © 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.