draft-ietf-sieve-notify-xmpp-01.txt   draft-ietf-sieve-notify-xmpp-02.txt 
Sieve Working Group P. Saint-Andre Sieve Working Group P. Saint-Andre
Internet-Draft Jabber Software Foundation Internet-Draft Jabber Software Foundation
Expires: December 25, 2006 A. Melnikov Expires: January 22, 2007 A. Melnikov
Isode Limited Isode Limited
June 23, 2006 July 21, 2006
Sieve Notification Mechanism: xmpp Sieve Notification Mechanism: xmpp
draft-ietf-sieve-notify-xmpp-01 draft-ietf-sieve-notify-xmpp-02
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 December 25, 2006. This Internet-Draft will expire on January 22, 2007.
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 tag ":method" . . . . . . . . . . . . . . . . . . . 3 2.1. Notify tag ":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 ":priority" . . . . . . . . . . . . . . . . . . 4 2.4. Notify tag ":priority" . . . . . . . . . . . . . . . . . . 4
2.5 Notify tag ":message" . . . . . . . . . . . . . . . . . . 4 2.5. Notify tag ":message" . . . . . . . . . . . . . . . . . . . 4
3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4. Internationalization Considerations . . . . . . . . . . . . . 5 4. Internationalization Considerations . . . . . . . . . . . . . . 5
5. Security Considerations . . . . . . . . . . . . . . . . . . . 5 5. Security Considerations . . . . . . . . . . . . . . . . . . . . 6
6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 6 6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 6
6.1 Normative References . . . . . . . . . . . . . . . . . . . 6 6.1. Normative References . . . . . . . . . . . . . . . . . . . 6
6.2 Informative References . . . . . . . . . . . . . . . . . . 6 6.2. Informative References . . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 7 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 8
Intellectual Property and Copyright Statements . . . . . . . . 8 Intellectual Property and Copyright Statements . . . . . . . . . . 9
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]), which is widely
implemented in Jabber technologies.
1.2 Terminology 1.2. Terminology
This document inherits terminology from [NOTIFY], [SIEVE], and This document inherits terminology from [NOTIFY], [SIEVE], and
[XMPP]. [XMPP].
The capitalized key words "MUST", "MUST NOT", "REQUIRED", "SHALL", The capitalized key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
"SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT
RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
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 general XMPP syntax
an XMPP <message/> stanza. The value of the XMPP 'type' attribute is as follows:
MUST be 'headline' or 'normal'. The value of the XMPP 'from'
attribute MUST be the XMPP address of the notification service. The
XMPP <message/> stanza MAY include a <subject/> child element whose
value is some configurable text indicating that the message is a
Sieve notification.
The format of the notify action is described in the following o The notification MUST be an XMPP <message/> stanza.
sections. o The value of the XMPP 'type' attribute MUST be 'headline' or
'normal'.
o The value of the XMPP 'from' attribute MUST be the XMPP address of
the notification service.
o The XMPP <message/> stanza MAY include a <subject/> child element
whose value is some configurable text indicating that the message
is a Sieve notification.
o The notification SHOULD include a URL for the recipient to use as
a hint in locating the message, encapsulated as the XML character
data of a <url/> child element of an <x/> element qualified by the
'jabber:x:oob' namespace as specified in [JEP-0066].
2.1 Notify tag ":method" The recommended mapping of the Sieve notify action into XMPP syntax
is described in the following sections.
2.1. Notify tag ":method"
The ":method" tag MUST be a URI that conforms to the xmpp URI scheme The ":method" tag MUST be a URI that conforms to the xmpp URI scheme
(as specified in [XMPP-URI]) and that identifies an XMPP account (as specified in [XMPP-URI]) and that identifies an XMPP account
associated with the email inbox. The URI MAY include the resource associated with the email inbox. The URI MAY include the resource
identifier portion of an XMPP address but SHOULD NOT include an identifier portion of an XMPP address but SHOULD NOT include 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 tag ":from" 2.2. Notify tag ":from"
The ":from" tag has no special meaning for this notification The ":from" tag has no special meaning for this notification
mechanism, and this specification puts no restriction on its use. As mechanism, and this specification puts no restriction on its use. As
noted, the value of the XMPP 'from' attribute specified in the XMPP noted, the value of the XMPP 'from' attribute specified in the XMPP
notification message MUST be the XMPP address of the notification notification message MUST be the XMPP address of the notification
service itself. The value of the ":from" tag MAY be transformed into service itself. The value of the ":from" tag MAY be transformed into
XMPP syntax; if so, it SHOULD be encapsulated as the value of an XMPP syntax; if so, it SHOULD be encapsulated as the value of an
[XMPP-SHIM] header named "Reply-To". [JEP-0131] header named "Reply-To".
2.3 Notify tag ":options" 2.3. Notify tag ":options"
The ":options" tag has no special meaning for this notification The ":options" tag has no special meaning for this notification
mechanism. Any handling of this tag is the responsibility of an mechanism. Any handling of this tag is the responsibility of an
implementation. implementation.
2.4 Notify tag ":priority" 2.4. Notify tag ":priority"
The ":priority" tag has no special meaning for this notification The ":priority" tag has no special meaning for this notification
mechanism, and this specification puts no restriction on its use. mechanism, and this specification puts no restriction on its use.
The value of the ":priority" tag MAY be transformed into XMPP syntax; 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] if so, it MUST be encapsulated as the value of an [JEP-0131] header
header named "Urgency", and the XML character of that header SHOULD named "Urgency", and the XML character of that header MUST be "high"
be "high" if the value of the ":priority" tag is "1", "medium" if the if the value of the ":priority" tag is "1", "medium" if the value of
value of the ":priority" tag is "2", or "low" if the value of the the ":priority" tag is "2", or "low" if the value of the ":priority"
":priority" tag is "3". 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 SHOULD 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
skipping to change at page 5, line 13 skipping to change at page 5, line 20
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> </message>
The following is a more advanced Sieve notify action with a method, The following is a more advanced Sieve notify action with a method,
priority, and message: priority, and message, as well as a URL pointing to the message:
notify :method "xmpp:romeo@example.com" notify :method "xmpp:romeo@example.com"
:priority "high" :priority "1"
:message "Contact Juliet immediately!" :message "Contact Juliet immediately!"
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>Contact Juliet immediately!</body> <body>Contact Juliet immediately!</body>
<headers xmlns='http://jabber.org/protocol/shim'> <headers xmlns='http://jabber.org/protocol/shim'>
<header name='Urgency'>high</header> <header name='Urgency'>high</header>
</headers> </headers>
<x xmlns='jabber:x:oob'>
<url>
imap://romeo@example.com/INBOX;UIDVALIDITY=385759045/;UID=20
</url>
</x>
</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.
skipping to change at page 6, line 5 skipping to change at page 6, line 19
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].
6. References 6. References
6.1 Normative References 6.1. Normative References
[JEP-0066]
Saint-Andre, P., "Out of Band Data", JSF JEP 0066,
January 2006.
[JEP-0131]
Saint-Andre, P. and J. Hildebrand, "Stanza Headers and
Internet Metadata", JSF JEP 0131, August 2005.
[NOTIFY] Melnikov, A., "Sieve Extension: Notifications", [NOTIFY] Melnikov, A., "Sieve Extension: Notifications",
draft-ietf-sieve-notify-03 (work in progress), June 2006. draft-ietf-sieve-notify-03 (work in progress), June 2006.
[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-06 (work in progress), Language", draft-ietf-sieve-3028bis-06 (work in progress),
March 2006. 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
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-04 (work in progress), draft-saintandre-xmpp-iri-04 (work in progress),
March 2006. 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
10021 and RFC 822", RFC 1327, May 1992.
[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
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.
[XMPP-SHIM] [UTF-8] Yergeau, F., "UTF-8, a transformation format of ISO
Saint-Andre, P. and J. Hildebrand, "Stanza Headers and 10646", STD 63, RFC 3629, November 2003.
Internet Metadata (SHIM)", JSF JEP 0131, August 2005.
[XMPP] Saint-Andre, P., "Extensible Messaging and Presence
Protocol (XMPP): Core", RFC 3920, October 2004.
Authors' Addresses Authors' Addresses
Peter Saint-Andre Peter Saint-Andre
Jabber Software Foundation Jabber Software Foundation
Email: stpeter@jabber.org Email: stpeter@jabber.org
Alexey Melnikov Alexey Melnikov
Isode Limited Isode Limited
 End of changes. 28 change blocks. 
56 lines changed or deleted 71 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/