draft-ietf-sieve-notify-xmpp-04.txt   draft-ietf-sieve-notify-xmpp-05.txt 
Sieve Working Group P. Saint-Andre Sieve Working Group P. Saint-Andre
Internet-Draft XSF Internet-Draft XMPP Standards Foundation
Expires: September 2, 2007 A. Melnikov Intended status: Standards Track A. Melnikov
Isode Limited Expires: April 3, 2008 Isode Limited
March 1, 2007 October 1, 2007
Sieve Notification Mechanism: xmpp Sieve Notification Mechanism: xmpp
draft-ietf-sieve-notify-xmpp-04 draft-ietf-sieve-notify-xmpp-05
Status of this Memo Status of this Memo
By submitting this Internet-Draft, each author represents that any By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware 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 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. 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
skipping to change at page 1, line 35 skipping to change at page 1, line 35
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 September 2, 2007. This Internet-Draft will expire on April 3, 2008.
Copyright Notice Copyright Notice
Copyright (C) The IETF Trust (2007). Copyright (C) The IETF Trust (2007).
Abstract Abstract
This document describes a profile of the Sieve extension for This document describes a profile of the Sieve extension for
notifications, to allow notifications to be sent over the Extensible notifications, to allow notifications to be sent over the Extensible
Messaging and Presence Protocol (XMPP), also known as Jabber. Messaging and Presence Protocol (XMPP), also known as Jabber.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1. Notify parameter "method" . . . . . . . . . . . . . . . . . 3 2.1. Notify parameter "method" . . . . . . . . . . . . . . . . 3
2.2. Notify tag ":from" . . . . . . . . . . . . . . . . . . . . 4 2.2. Notify tag ":from" . . . . . . . . . . . . . . . . . . . . 4
2.3. Notify tag ":options" . . . . . . . . . . . . . . . . . . . 4 2.3. Notify tag ":options" . . . . . . . . . . . . . . . . . . 4
2.4. Notify tag ":importance" . . . . . . . . . . . . . . . . . 4 2.4. Notify tag ":importance" . . . . . . . . . . . . . . . . . 4
2.5. Notify tag ":message" . . . . . . . . . . . . . . . . . . . 4 2.5. Notify tag ":message" . . . . . . . . . . . . . . . . . . 4
3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4. Requirements Conformance . . . . . . . . . . . . . . . . . . . 5 4. Requirements Conformance . . . . . . . . . . . . . . . . . . . 5
5. Internationalization Considerations . . . . . . . . . . . . . . 6 5. Internationalization Considerations . . . . . . . . . . . . . 7
6. Security Considerations . . . . . . . . . . . . . . . . . . . . 7 6. Security Considerations . . . . . . . . . . . . . . . . . . . 7
7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 7 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
7.1. Normative References . . . . . . . . . . . . . . . . . . . 7 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 7
7.2. Informative References . . . . . . . . . . . . . . . . . . 8 8.1. Normative References . . . . . . . . . . . . . . . . . . . 7
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 8 8.2. Informative References . . . . . . . . . . . . . . . . . . 8
Intellectual Property and Copyright Statements . . . . . . . . . . 9 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 9
Intellectual Property and Copyright Statements . . . . . . . . . . 10
1. Introduction 1. Introduction
1.1. Overview 1.1. Overview
The [NOTIFY] extension to the [SIEVE] mail filtering language is a The [NOTIFY] extension to the [SIEVE] mail filtering language is a
framework for providing notifications by employing URIs to specify framework for providing notifications by employing URIs to specify
the notification mechanism. This document defines how xmpp URIs (see the notification mechanism. This document defines how xmpp URIs (see
[XMPP-URI]) are used to generate notifications via the Extensible [XMPP-URI]) are used to generate notifications via the Extensible
Messaging and Presence Protocol (see [XMPP]), which is widely Messaging and Presence Protocol (see [XMPP]), which is widely
skipping to change at page 4, line 42 skipping to change at page 4, line 42
The value of the ":importance" tag MAY be transformed into XMPP The value of the ":importance" tag MAY be transformed into XMPP
syntax (in addition to or instead of including in the default syntax (in addition to or instead of including in the default
message); if so, it MUST be encapsulated as the value of an XMPP message); if so, it MUST be encapsulated as the value of an XMPP
[SHIM] header named "Urgency", and the XML character of that header [SHIM] header named "Urgency", and the XML character of that header
MUST be "high" if the value of the ":importance" tag is "1", "medium" MUST be "high" if the value of the ":importance" tag is "1", "medium"
if the value of the ":importance" tag is "2", or "low" if the value if the value of the ":importance" tag is "2", or "low" if the value
of the ":importance" tag is "3". of the ":importance" tag is "3".
2.5. Notify tag ":message" 2.5. Notify tag ":message"
If included, the ":message" tag SHOULD be transformed into the XML If included, the ":message" tag MUST be transformed into the XML
character data of an XMPP <body/> element. If not included, the rule character data of an XMPP <body/> element. If not included, the rule
specified in [NOTIFY] SHOULD be followed, as shown in the examples specified in [NOTIFY] SHOULD be followed, as shown in the examples
below. below.
3. Examples 3. Examples
In the following examples, the sender of the email has an address of In the following examples, the sender of the email has an address of
<mailto:juliet@example.org>, the entity to be notified has an XMPP <mailto:juliet@example.org>, the entity to be notified has an XMPP
address of <xmpp:romeo@example.com>, and the notification service has address of romeo@example.com (resulting in an XMPP URI of
an XMPP address <xmpp:notify.example.com>. <xmpp:romeo@example.com>), and the notification service has an XMPP
address of notify.example.com (resulting in an XMPP URI of <xmpp:
notify.example.com>).
The following is a basic Sieve notify action with only a method: The following is a basic Sieve notify action with only a method:
notify "xmpp:romeo@example.com" notify "xmpp:romeo@example.com"
The resulting XMPP <message/> stanza might be as follows: The resulting XMPP <message/> stanza might be as follows:
<message from='notify.example.com' <message from='notify.example.com'
to='romeo@example.com' to='romeo@example.com'
xml:lang='en'> xml:lang='en'>
skipping to change at page 6, line 5 skipping to change at page 6, line 6
</url> </url>
</x> </x>
</message> </message>
4. Requirements Conformance 4. Requirements Conformance
Section 3.8 of [NOTIFY] specifies a set of requirements for Sieve Section 3.8 of [NOTIFY] specifies a set of requirements for Sieve
notification methods. The conformance of the xmpp notification notification methods. The conformance of the xmpp notification
mechanism is provided here. mechanism is provided here.
1. An implementation of the xmpp notification method MAY modify the 1. An implementation of the xmpp notification method SHOULD NOT
final notification text (e.g., limit the length to a configurable modify the final notification text (e.g., to limit the length);
number of characters, such as 200). Modification of characters however, a given deployment MAY do so (e.g., if recipients pay
themselves should not be necessary, since XMPP character data is per character or byte for XMPP messages). Modification of
encoded in [UTF-8]. characters themselves should not be necessary, since XMPP
character data is encoded in [UTF-8].
2. An implementation MAY ignore parameters specified in the ":from", 2. An implementation MAY ignore parameters specified in the ":from",
":options", ":importance", and ":message" tags. ":importance", and ":options" tags.
3. The xmpp notification method does not recommend the default 3. There is no recommended default message for an implementation to
message to be used if the ":message" argument is not specified. include if the ":message" argument is not specified.
4. A notification sent via the xmpp notification method MAY include 4. A notification sent via the xmpp notification method MAY include
a timestamp in the textual message. a timestamp in the textual message.
5. The value of the XMPP 'from' attribute MUST be the XMPP address 5. The value of the XMPP 'from' attribute MUST be the XMPP address
of the xmpp notification service. The value of the Sieve ":from" of the xmpp notification service. The value of the Sieve ":from"
tag MAY be transformed into the value of an XMPP [SHIM] header tag MAY be transformed into the value of an XMPP [SHIM] header
named "Reply-To". named "Reply-To".
6. An implementation MUST NOT include any other extraneous 6. An implementation MUST NOT include any other extraneous
information not specified in parameters to the notify action. information not specified in parameters to the notify action.
7. In accordance with [XMPP-URI], an implementation MUST ignore any 7. In accordance with [XMPP-URI], an implementation MUST ignore any
URI action or parameter it does not understand (i.e., the URI URI action or parameter it does not understand (i.e., the URI
MUST be processed as if the action or parameter were not MUST be processed as if the action or parameter were not
present). It is RECOMMENDED to support the "message" action and present). It is RECOMMENDED to support the XMPP "message" query
the associated "body" and "subject" parameters, which parameters type (see [QUERIES]) and the associated "body" and "subject"
SHOULD be mapped to the XMPP <body/> and <subject/> child parameters, which parameters SHOULD be mapped to the XMPP <body/>
elements of the XMPP <message/> stanza type, respectively. and <subject/> child elements of the XMPP <message/> stanza type,
respectively. However, if included then the Sieve notify
":message" parameter MUST be mapped to the XMPP <body/> element,
overriding the "body" parameter (if any) included in the XMPP
URI.
8. In response to a notify_method_capability test for the "online" 8. In response to a notify_method_capability test for the "online"
notification-capability, an implementation SHOULD return a value notification-capability, an implementation SHOULD return a value
of "yes" if it has knowledge of an active presence session for of "yes" if it has knowledge of an active presence session for
the specified notification-uri and a value of "no" if it does not the specified notification-uri and a value of "no" if it does not
have such knowledge. have such knowledge.
9. An implementation SHOULD NOT attempt to retry delivery of a 9. An implementation SHOULD NOT attempt to retry delivery of a
notification if it receives an XMPP error of type "auth" or notification if it receives an XMPP error of type "auth" or
"cancel", MAY attempt to retry delivery if it receives an XMPP "cancel", MAY attempt to retry delivery if it receives an XMPP
error of type "wait", and MAY attempt to retry delivery if it error of type "wait", and MAY attempt to retry delivery if it
receives an XMPP error of "modify" but only if it makes receives an XMPP error of "modify" but only if it makes
skipping to change at page 7, line 19 skipping to change at page 7, line 25
6. Security Considerations 6. Security Considerations
Depending on the information included, sending a notification can be Depending on the information included, sending a notification can be
comparable to forwarding mail to the notification recipient. Care comparable to forwarding mail to the notification recipient. Care
must be taken when forwarding mail automatically, to ensure that must be taken when forwarding mail automatically, to ensure that
confidential information is not sent into an insecure environment. confidential information is not sent into an insecure environment.
In particular, implementations MUST conform to the security In particular, implementations MUST conform to the security
considerations given in [NOTIFY], [SIEVE], and [XMPP]. considerations given in [NOTIFY], [SIEVE], and [XMPP].
7. References 7. IANA Considerations
7.1. Normative References The following template provides the IANA registration of the Sieve
notification mechanism specified in this document:
[OOB] Saint-Andre, P., "Out of Band Data", XSF XEP 0066, To: iana@iana.org
January 2006. Subject: Registration of new Sieve notification mechanism
Mechanism name: xmpp
Mechanism URI: RFC4622
Mechanism-specific tags: none
Standards Track/IESG-approved experimental RFC number: this RFC
Person and email address to contact for further information:
Peter Saint-Andre <stpeter@jabber.org>
This information should be added to the list of Sieve notification
mechanisms maintained at
<http://www.iana.org/assignments/sieve-notification>.
8. References
8.1. Normative References
[NOTIFY] Melnikov, A., Leiba, B., Segmuller, W., and T. Martin, [NOTIFY] Melnikov, A., Leiba, B., Segmuller, W., and T. Martin,
"Sieve Extension: Notifications", "Sieve Extension: Notifications",
draft-ietf-sieve-notify-07 (work in progress), draft-ietf-sieve-notify-08 (work in progress), July 2007.
February 2007.
[OOB] Saint-Andre, P., "Out of Band Data", XSF XEP 0066,
August 2006.
[QUERIES] Saint-Andre, P., "XMPP URI Scheme Query Components", XSF
XEP 0147, September 2006.
[SHIM] Saint-Andre, P. and J. Hildebrand, "Stanza Headers and [SHIM] Saint-Andre, P. and J. Hildebrand, "Stanza Headers and
Internet Metadata", XSF XEP 0131, August 2005. Internet Metadata", XSF XEP 0131, August 2005.
[SIEVE] Showalter, T. and P. Guenther, "Sieve: An Email Filtering [SIEVE] Showalter, T. and P. Guenther, "Sieve: An Email Filtering
Language", draft-ietf-sieve-3028bis-12 (work in progress), Language", draft-ietf-sieve-3028bis-12 (work in progress),
February 2007. February 2007.
[TERMS] Bradner, S., "Key words for use in RFCs to Indicate [TERMS] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[XMPP-URI] [XMPP-URI]
Saint-Andre, P., "Internationalized Resource Identifiers Saint-Andre, P., "Internationalized Resource Identifiers
(IRIs) and Uniform Resource Identifiers (URIs) for the (IRIs) and Uniform Resource Identifiers (URIs) for the
Extensible Messaging and Presence Protocol (XMPP)", Extensible Messaging and Presence Protocol (XMPP)",
RFC 4622, August 2006. draft-saintandre-rfc4622bis-01 (work in progress),
June 2007.
7.2. Informative References 8.2. Informative References
[IRI] Duerst, M. and M. Suignard, "Internationalized Resource [IRI] Duerst, M. and M. Suignard, "Internationalized Resource
Identifiers (IRIs)", RFC 3987, January 2005. Identifiers (IRIs)", RFC 3987, January 2005.
[UNICODE] The Unicode Consortium, "The Unicode Standard, Version [UNICODE] The Unicode Consortium, "The Unicode Standard, Version
3.2.0", 2000. 3.2.0", 2000.
The Unicode Standard, Version 3.2.0 is defined by The The Unicode Standard, Version 3.2.0 is defined by The
Unicode Standard, Version 3.0 (Reading, MA, Addison- Unicode Standard, Version 3.0 (Reading, MA, Addison-
Wesley, 2000. ISBN 0-201-61633-5), as amended by the Wesley, 2000. ISBN 0-201-61633-5), as amended by the
skipping to change at page 8, line 37 skipping to change at page 9, line 11
[XMPP] Saint-Andre, P., "Extensible Messaging and Presence [XMPP] Saint-Andre, P., "Extensible Messaging and Presence
Protocol (XMPP): Core", RFC 3920, October 2004. Protocol (XMPP): Core", RFC 3920, October 2004.
Authors' Addresses Authors' Addresses
Peter Saint-Andre Peter Saint-Andre
XMPP Standards Foundation XMPP Standards Foundation
Email: stpeter@jabber.org Email: stpeter@jabber.org
URI: https://stpeter.im/
Alexey Melnikov Alexey Melnikov
Isode Limited Isode Limited
Email: Alexey.Melnikov@isode.com Email: Alexey.Melnikov@isode.com
Full Copyright Statement Full Copyright Statement
Copyright (C) The IETF Trust (2007). Copyright (C) The IETF Trust (2007).
 End of changes. 20 change blocks. 
40 lines changed or deleted 70 lines changed or added

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