Sieve Working Group P. Saint-Andre
Internet-Draft XMPP Standards Foundation
Intended status: Standards Track A. Melnikov
Expires: May 10, 2008 Isode Limited
November 7, 2007
Sieve Notification Mechanism: xmpp
draft-ietf-sieve-notify-xmpp-06
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 May 10, 2008.
Copyright Notice
Copyright (C) The IETF Trust (2007).
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 May 10, 2008 [Page 1]
Internet-Draft SIEVE-XMPP November 2007
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1. Notify parameter "method" . . . . . . . . . . . . . . . . 4
2.2. Notify tag ":from" . . . . . . . . . . . . . . . . . . . . 4
2.3. Notify tag ":options" . . . . . . . . . . . . . . . . . . 4
2.4. Notify tag ":importance" . . . . . . . . . . . . . . . . . 4
2.5. Notify tag ":message" . . . . . . . . . . . . . . . . . . 4
3. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. Requirements Conformance . . . . . . . . . . . . . . . . . . . 6
5. Internationalization Considerations . . . . . . . . . . . . . 7
6. Security Considerations . . . . . . . . . . . . . . . . . . . 7
7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 8
8.1. Normative References . . . . . . . . . . . . . . . . . . . 8
8.2. Informative References . . . . . . . . . . . . . . . . . . 9
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 9
Intellectual Property and Copyright Statements . . . . . . . . . . 11
Saint-Andre & Melnikov Expires May 10, 2008 [Page 2]
Internet-Draft SIEVE-XMPP November 2007
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]), which is widely
implemented in Jabber instant messaging technologies.
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 [TERMS].
2. Definition
The xmpp mechanism results in the sending of an XMPP message to
notify a recipient about an email message. The general XMPP syntax
is as follows:
o The notification MUST be an XMPP stanza.
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 associated with the SIEVE engine.
o The XMPP stanza MAY include a child element
whose value is some configurable text indicating that the message
is a Sieve notification.
o The notification SHOULD include a URI for the recipient to use as
a hint in locating the message, encapsulated as the XML character
data of a child element of an element qualified by the
'jabber:x:oob' namespace as specified in [OOB]. If included, the
URI SHOULD be an Internet Message Access Protocol [IMAP] URL that
specifies the location of the message as defined in [IMAP-URL],
but MAY be another URI type that can specify or hint at the
location of an email message, such as a URI for an HTTP resource
[HTTP] or a POP3 mailbox [POP-URL] at which the message can be
accessed. It is not expected that an XMPP user agent shall
directly handle such a URI, but instead that it shall invoke an
appropriate helper application to handle the URI.
Saint-Andre & Melnikov Expires May 10, 2008 [Page 3]
Internet-Draft SIEVE-XMPP November 2007
The recommended mapping of the Sieve notify action into XMPP syntax
is described in the following sections.
2.1. Notify parameter "method"
The "method" parameter 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.
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 associated with the SIEVE engine. 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 ":importance"
The ":importance" tag has no special meaning for this notification
mechanism, and this specification puts no restriction on its use.
The value of the ":importance" tag MAY be transformed into XMPP
syntax (in addition to or instead of including in the default
message); if so, it SHOULD be encapsulated as the value of an XMPP
[SHIM] header named "Urgency", where the XML character of that header
is "high" if the value of the ":importance" tag is "1", "medium" if
the value of the ":importance" tag is "2", and "low" if the value of
the ":importance" tag is "3".
2.5. Notify tag ":message"
If the ":message" tag is included, that string MUST be transformed
into the XML character data of an XMPP