Sieve Working Group P. Saint-Andre
Internet-Draft Jabber Software Foundation
Expires: December 25, 2006 A. Melnikov
Isode Limited
June 23, 2006
Sieve Notification Mechanism: xmpp
draft-ietf-sieve-notify-xmpp-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 December 25, 2006.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
This document describes a profile of the Sieve extension for
notifications, to allow notifications to be sent over the Extensible
Messaging and Presence Protocol (XMPP), also known as Jabber.
Saint-Andre & Melnikov Expires December 25, 2006 [Page 1]
Internet-Draft SIEVE-XMPP June 2006
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1 Notify tag ":method" . . . . . . . . . . . . . . . . . . . 3
2.2 Notify tag ":from" . . . . . . . . . . . . . . . . . . . . 4
2.3 Notify tag ":options" . . . . . . . . . . . . . . . . . . 4
2.4 Notify tag ":priority" . . . . . . . . . . . . . . . . . . 4
2.5 Notify tag ":message" . . . . . . . . . . . . . . . . . . 4
3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
4. Internationalization Considerations . . . . . . . . . . . . . 5
5. Security Considerations . . . . . . . . . . . . . . . . . . . 5
6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 6
6.1 Normative References . . . . . . . . . . . . . . . . . . . 6
6.2 Informative References . . . . . . . . . . . . . . . . . . 6
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 7
Intellectual Property and Copyright Statements . . . . . . . . 8
Saint-Andre & Melnikov Expires December 25, 2006 [Page 2]
Internet-Draft SIEVE-XMPP June 2006
1. Introduction
1.1 Overview
The [NOTIFY] extension to the [SIEVE] mail filtering language is a
framework for providing notifications by employing URIs to specify
the notification mechanism. This document defines how xmpp URIs (see
[XMPP-URI]) are used to generate notifications via the Extensible
Messaging and Presence Protocol (see [XMPP]), also known as Jabber.
1.2 Terminology
This document inherits terminology from [NOTIFY], [SIEVE], and
[XMPP].
The capitalized key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
"SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT
RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in RFC 2119 [TERMS].
2. Definition
The xmpp mechanism results in the sending of an XMPP message to
notify a recipient about an email message. The notification MUST be
an XMPP stanza. The value of the XMPP 'type' attribute
MUST be 'headline' or 'normal'. The value of the XMPP 'from'
attribute MUST be the XMPP address of the notification service. The
XMPP stanza MAY include a 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
sections.
2.1 Notify tag ":method"
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
associated with the email inbox. The URI MAY include the resource
identifier portion of an XMPP address but SHOULD NOT include an
authority component, query component, or fragment identifier
component. The processing application MUST extract an XMPP address
from the URI in accordance with the processing rules specified in
[XMPP-URI]. The resulting XMPP address MUST be encapsulated in XMPP
syntax as the value of the XMPP 'to' attribute.
Saint-Andre & Melnikov Expires December 25, 2006 [Page 3]
Internet-Draft SIEVE-XMPP June 2006
2.2 Notify tag ":from"
The ":from" tag has no special meaning for this notification
mechanism, and this specification puts no restriction on its use. As
noted, the value of the XMPP 'from' attribute specified in the XMPP
notification message MUST be the XMPP address of the notification
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-SHIM] header named "Reply-To".
2.3 Notify tag ":options"
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