draft-ietf-sieve-notify-xmpp-00.txt   draft-ietf-sieve-notify-xmpp-01.txt 
Sieve Working Group P. Saint-Andre Sieve Working Group P. Saint-Andre
Internet-Draft Jabber Software Foundation Internet-Draft Jabber Software Foundation
Expires: July 21, 2006 A. Melnikov Expires: December 25, 2006 A. Melnikov
Isode Limited Isode Limited
January 17, 2006 June 23, 2006
Sieve Notification Mechanism: xmpp Sieve Notification Mechanism: xmpp
draft-ietf-sieve-notify-xmpp-00 draft-ietf-sieve-notify-xmpp-01
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 July 21, 2006. This Internet-Draft will expire on December 25, 2006.
Copyright Notice Copyright Notice
Copyright (C) The Internet Society (2006). Copyright (C) The Internet Society (2006).
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 ":method" tag . . . . . . . . . . . . . . . . . . . 3 2.1 Notify tag ":method" . . . . . . . . . . . . . . . . . . . 3
2.2 Notify ":priority" tag . . . . . . . . . . . . . . . . . . 4 2.2 Notify tag ":from" . . . . . . . . . . . . . . . . . . . . 4
3. Example . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.3 Notify tag ":options" . . . . . . . . . . . . . . . . . . 4
4. Internationalization Considerations . . . . . . . . . . . . . 4 2.4 Notify tag ":priority" . . . . . . . . . . . . . . . . . . 4
5. Security Considerations . . . . . . . . . . . . . . . . . . . 4 2.5 Notify tag ":message" . . . . . . . . . . . . . . . . . . 4
6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
6.1 Normative References . . . . . . . . . . . . . . . . . . . 5 4. Internationalization Considerations . . . . . . . . . . . . . 5
6.2 Informative References . . . . . . . . . . . . . . . . . . 5 5. Security Considerations . . . . . . . . . . . . . . . . . . . 5
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 6 6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Intellectual Property and Copyright Statements . . . . . . . . 7 6.1 Normative References . . . . . . . . . . . . . . . . . . . 6
6.2 Informative References . . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 7
Intellectual Property and Copyright Statements . . . . . . . . 8
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]), also known as Jabber. Messaging and Presence Protocol (see [XMPP]), also known as Jabber.
skipping to change at page 3, line 33 skipping to change at page 3, line 33
interpreted as described in RFC 2119 [TERMS]. interpreted as described in RFC 2119 [TERMS].
2. Definition 2. Definition
The xmpp mechanism results in the sending of an XMPP message to The xmpp mechanism results in the sending of an XMPP message to
notify a recipient about an email message. The notification MUST be notify a recipient about an email message. The notification MUST be
an XMPP <message/> stanza. The value of the XMPP 'type' attribute an XMPP <message/> stanza. The value of the XMPP 'type' attribute
MUST be 'headline' or 'normal'. The value of the XMPP 'from' MUST be 'headline' or 'normal'. The value of the XMPP 'from'
attribute MUST be the XMPP address of the notification service. The attribute MUST be the XMPP address of the notification service. The
XMPP <message/> stanza MAY include a <subject/> child element whose XMPP <message/> stanza MAY include a <subject/> child element whose
value is either the ":subject" tag or, absent that, some configurable value is some configurable text indicating that the message is a
text indicating that the message is a Sieve notification. Sieve notification.
The format of the notify action is described in the following The format of the notify action is described in the following
sections. sections.
2.1 Notify ":method" tag 2.1 Notify tag ":method"
The notify ":method" tag MUST be a URI that conforms to the xmpp URI The ":method" tag MUST be a URI that conforms to the xmpp URI scheme
scheme (as specified in [XMPP-URI]) and that identifies an XMPP (as specified in [XMPP-URI]) and that identifies an XMPP account
account associated with the email inbox. The URI MAY include the associated with the email inbox. The URI MAY include the resource
resource identifier portion of an XMPP address but SHOULD NOT include identifier portion of an XMPP address but SHOULD NOT include an
an authority component, query component, or fragment identifier authority component, query component, or fragment identifier
component. The processing application MUST extract an XMPP address component. The processing application MUST extract an XMPP address
from the URI in accordance with the processing rules specified in from the URI in accordance with the processing rules specified in
[XMPP-URI]. The resulting XMPP address MUST be encapsulated in XMPP [XMPP-URI]. The resulting XMPP address MUST be encapsulated in XMPP
syntax as the value of the XMPP 'to' attribute. syntax as the value of the XMPP 'to' attribute.
2.2 Notify ":priority" tag 2.2 Notify tag ":from"
The notify ":priority" tag has no special meaning for this The ":from" tag has no special meaning for this notification
notification mechanism, and this specification puts no restriction on mechanism, and this specification puts no restriction on its use. As
its use. The value of the notify ":priority" tag MAY be transformed noted, the value of the XMPP 'from' attribute specified in the XMPP
into XMPP syntax; if so, it SHOULD be encapsulated as the value of an notification message MUST be the XMPP address of the notification
[XMPP-SHIM] header named "Urgency", and the XML character of that service itself. The value of the ":from" tag MAY be transformed into
header SHOULD be "high", "medium", or "low". XMPP syntax; if so, it SHOULD be encapsulated as the value of an
[XMPP-SHIM] header named "Reply-To".
3. Example 2.3 Notify tag ":options"
Consider the following Sieve notify action: The ":options" tag has no special meaning for this notification
mechanism. Any handling of this tag is the responsibility of an
implementation.
2.4 Notify tag ":priority"
The ":priority" tag has no special meaning for this notification
mechanism, and this specification puts no restriction on its use.
The value of the ":priority" tag MAY be transformed into XMPP syntax;
if so, it SHOULD be encapsulated as the value of an [XMPP-SHIM]
header named "Urgency", and the XML character of that header SHOULD
be "high" if the value of the ":priority" tag is "1", "medium" if the
value of the ":priority" tag is "2", or "low" if the value of the
":priority" tag is "3".
2.5 Notify tag ":message"
If included, the ":message" tag SHOULD be transformed into the XML
character data of an XMPP <body/> element. If not included, the rule
specified in [NOTIFY] SHOULD be followed, as shown in the examples
below.
3. Examples
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
address of <xmpp:romeo@example.com>, and the notification service has
an XMPP address <xmpp:notify.example.com>.
The following is a basic Sieve notify action with only a method:
notify :method "xmpp:romeo@example.com" notify :method "xmpp:romeo@example.com"
:id "some-id"
:priority "high"
:message "<juliet@example.org> Wherefore art thou?";
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'>
<subject>A Sieve instant notification!</subject> <subject>A Sieve instant notification!</subject>
<body>&lt;juliet@example.org&gt; Wherefore art thou?</body> <body>&lt;juliet@example.org&gt; Wherefore art thou?</body>
</message>
The following is a more advanced Sieve notify action with a method,
priority, and message:
notify :method "xmpp:romeo@example.com"
:priority "high"
:message "Contact Juliet immediately!"
The resulting XMPP <message/> stanza might be as follows:
<message from='notify.example.com'
to='romeo@example.com'
xml:lang='en'>
<subject>A Sieve instant notification!</subject>
<body>Contact Juliet immediately!</body>
<headers xmlns='http://jabber.org/protocol/shim'> <headers xmlns='http://jabber.org/protocol/shim'>
<header name='Priority'>urgent</header> <header name='Urgency'>high</header>
</headers> </headers>
</message> </message>
4. Internationalization Considerations 4. Internationalization Considerations
Although an XMPP address may contain nearly any [UNICODE] character, Although an XMPP address may contain nearly any [UNICODE] character,
the value of the ":method" tag MUST be a Uniform Resource Identifier the value of the ":method" tag MUST be a Uniform Resource Identifier
(see [URI]) rather than an Internationalized Resource Identifier (see (see [URI]) rather than an Internationalized Resource Identifier (see
[IRI]). The rules specified in [XMPP-URI] MUST be followed when [IRI]). The rules specified in [XMPP-URI] MUST be followed when
generating XMPP URIs. generating XMPP URIs.
In accordance with Section 13 of RFC 3920, all data sent over XMPP
MUST be encoded in [UTF-8].
5. Security Considerations 5. Security Considerations
Detailed security considerations for the relevant protocols profiled Depending on the information included, sending a notification can be
in this document are given in [NOTIFY], [SIEVE], and [XMPP]; this comparable to forwarding mail to the notification recipient. Care
document introduces no new security concerns above and beyond those must be taken when forwarding mail automatically, to ensure that
described in the foregoing specifications. confidential information is not sent into an insecure environment.
In particular, implementations MUST conform to the security
considerations given in [NOTIFY], [SIEVE], and [XMPP].
6. References 6. References
6.1 Normative References 6.1 Normative References
[NOTIFY] Melnikov, A., "Sieve -- An extension for providing instant [NOTIFY] Melnikov, A., "Sieve Extension: Notifications",
notifications", draft-ietf-sieve-notify-01 (work in draft-ietf-sieve-notify-03 (work in progress), June 2006.
progress), October 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-05 (work in progress), Language", draft-ietf-sieve-3028bis-06 (work in progress),
November 2005. March 2006.
[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.
[UTF-8] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003.
[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.
[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)",
draft-saintandre-xmpp-iri-03 (work in progress), draft-saintandre-xmpp-iri-04 (work in progress),
December 2005. March 2006.
6.2 Informative References 6.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.
[RFC1327] Hardcastle-Kille, S., "Mapping between X.400(1988) / ISO [RFC1327] Hardcastle-Kille, S., "Mapping between X.400(1988) / ISO
10021 and RFC 822", RFC 1327, May 1992. 10021 and RFC 822", RFC 1327, May 1992.
[UNICODE] The Unicode Consortium, "The Unicode Standard, Version [UNICODE] The Unicode Consortium, "The Unicode Standard, Version
skipping to change at page 5, line 51 skipping to change at page 7, line 5
Wesley, 2000. ISBN 0-201-61633-5), as amended by the Wesley, 2000. ISBN 0-201-61633-5), as amended by the
Unicode Standard Annex #27: Unicode 3.1 Unicode Standard Annex #27: Unicode 3.1
(http://www.unicode.org/reports/tr27/) and by the Unicode (http://www.unicode.org/reports/tr27/) and by the Unicode
Standard Annex #28: Unicode 3.2 Standard Annex #28: Unicode 3.2
(http://www.unicode.org/reports/tr28/). (http://www.unicode.org/reports/tr28/).
[URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform [URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, January 2005. RFC 3986, January 2005.
[UTF-8] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003.
[XMPP-SHIM] [XMPP-SHIM]
Saint-Andre, P. and J. Hildebrand, "Stanza Headers and Saint-Andre, P. and J. Hildebrand, "Stanza Headers and
Internet Metadata (SHIM)", JSF JEP 0131, August 2005. Internet Metadata (SHIM)", JSF JEP 0131, August 2005.
Authors' Addresses Authors' Addresses
Peter Saint-Andre Peter Saint-Andre
Jabber Software Foundation Jabber Software Foundation
Email: stpeter@jabber.org Email: stpeter@jabber.org
 End of changes. 22 change blocks. 
49 lines changed or deleted 99 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/