XEP-0109: Vacation Messages

Abstract:A protocol for setting up vacation messages in Jabber.
Author:Robert Norris
Copyright:© 1999 - 2010 XMPP Standards Foundation. SEE LEGAL NOTICES.
Last Updated:2003-08-12

WARNING: Consideration of this document has been Deferred by the XMPP Standards Foundation. Implementation of the protocol described herein is not recommended.

Table of Contents

1. Introduction
2. Requirements
3. Use cases
    3.1. Discovering support for vacation messages
    3.2. Retrieving the current vacation settings
    3.3. Setting new vacation settings
    3.4. Removing vacation settings
4. Server requirements
5. Security Considerations
6. IANA Considerations
7. XMPP Registrar Considerations
8. XML Schema

    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History

1. Introduction

Popular electronic mail systems have long including features that allow users to set up automated messages that are returned to message senders when the user is not able to deal with the message immediately. This feature is commonly known as "vacation messages", because it is most commonly used when a user is unable to read their messages because they are on vacation.

This document describes a similar system that allows Jabber users to setup vacation messages when they are away.

2. Requirements

The requirements for this document are fairly straightforward. A user MUST be able to:

Additionally, a server supporting vacation messages MUST respond to a message sent to a local user that has an active vacation message set by automatically sending that message to the sender.

3. Use cases

3.1 Discovering support for vacation messages

Before attempting to set or retrieve its current vacation settings, a user SHOULD first verify that their server supports vacation messages. To do this, the user makes a Service Discovery [1] "#info" query to their server. If supported, the server includes a feature of "http://www.jabber.org/protocol/vacation" in the result.

Example 1. Discovering support for vacation messages

<iq type='get' to='cataclysm.cx' id='disco1'>
  <query xmlns='http://www.jabber.org/protocol/disco#info'/>


Example 2. Discovery response

<iq type='result' from='cataclysm.cx' id='disco1'>
  <query xmlns='http://www.jabber.org/protocol/disco#info'>
    <feature var='http://www.jabber.org/protocol/vacation'/>

3.2 Retrieving the current vacation settings

A user may request their current vacation settings by sending an IQ get to the local server like so:

Example 3. Retrieving the current vacation settings

<iq type='get' id='get1'>
  <query xmlns='http://www.jabber.org/protocol/vacation'/>

Example 4. Server returns vacation settings

<iq type='result' id='get1'>
  <query xmlns='http://www.jabber.org/protocol/vacation'>
    <message>I'm attending OSCON in sunny Portland and won't be able to
             read your message until I get back. If its urgent, please
             send email to rob@cataclysm.cx.</message>

<start/> and <end/> define the times between which this vacation message is valid. These are in the format specified by XMPP Date and Time Profiles [2].

<message/> contains the text of the message that will be sent to a remote user that sends the user a message while they have active vacation settings.

If the user has no stored vacation settings, the user will receive a result like the following:

Example 5. User does not have any vacation settings

<iq type='result' id='get1'/>

3.3 Setting new vacation settings

A user may set new vacation settings by sending a IQ to the local server like so:

Example 6. Setting new vacation settings

<iq type='set' id='set1'>
  <query xmlns='http://www.jabber.org/protocol/vacation'>
    <message>I'm attending OSCON in sunny Portland and won't be able to
             read your message until I get back. If its urgent, please
             send email to rob@cataclysm.cx.</message>

Example 7. Vacation settings set successfully

<iq type='result' id='set1'/>

The meaning of each element is as outlined above. All elements are required.

Additionally, the <start/> and <end/> elements MAY be empty (ie have no CDATA). When <start/> is empty, the server MUST take this to mean that the settings should take effect immediately. Similarly, when <end/> is empty, the server MUST take this to mean that the settings should never expire (unless they are explicitly removed).

3.4 Removing vacation settings

A user may remove all stored vacation settings by sending a IQ to the local server like so:

Example 8. Remove vacation settings

<iq type='set' id='set2'>
  <query xmlns='http://www.jabber.org/protocol/vacation'/>

Example 9. Vacation settings removed successfully

<iq type='result' id='set2'/>

4. Server requirements

A server implementing vacation messages MUST reply to the message using the text specified in the receiving users' vacation settings if the time that message arrived from the remote users falls within data range specified, but only if the received message is to be queued for later delivery.

Implementing servers SHOULD (if local resource contraints allow) only send one automated response to a remote user for each local user that has active vacation settings. The memory of this action MUST be reset when the active settings have expired or when the user resets or removes them.

5. Security Considerations

None yet defined.

6. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [3].

7. XMPP Registrar Considerations

The 'http://jabber.org/protocol/vacation' namespace shall be registered with the XMPP Registrar [4] as a result of this document.

8. XML Schema

<?xml version='1.0' encoding='UTF-8'?>


  <xs:element name='query'>
        <xs:element ref='start' minOccurs='0' maxOccurs='1'/>
        <xs:element ref='end' minOccurs='0' maxOccurs='1'/>
        <xs:element ref='message' minOccurs='0' maxOccurs='1'/>

  <xs:element name='start' type='xs:string'/>
  <xs:element name='end' type='xs:string'/>
  <xs:element name='message' type='xs:string'/>



Appendix A: Document Information

Series: XEP
Number: 0109
Publisher: XMPP Standards Foundation
Status: Deferred
Type: Informational
Version: 0.2
Last Updated: 2003-08-12
Approving Body: XMPP Council
Dependencies: None
Supersedes: None
Superseded By: None
Short Name: vacation
Source Control: HTML  RSS
This document in other formats: XML  PDF

Appendix B: Author Information

Robert Norris

Email: rob@cataclysm.cx
JabberID: rob@cataclysm.cx

Appendix C: Legal Notices


This XMPP Extension Protocol is copyright © 1999 - 2010 by the XMPP Standards Foundation (XSF).


Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <http://xmpp.org/extensions/ipr-policy.shtml> or obtained by writing to XMPP Standards Foundation, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

1. XEP-0030: Service Discovery <http://xmpp.org/extensions/xep-0030.html>.

2. XEP-0082: XMPP Date and Time Profiles <http://xmpp.org/extensions/xep-0082.html>.

3. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

4. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://xmpp.org/registrar/>.

Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

Version 0.2 (2003-08-12)

Added use cases for removing vacation settings; described semantics when start and end times are not specified; changed document type to Informational; small editorial changes. (rn)

Version 0.1 (2003-07-28)

Initial version. (rn)