XEP-0109: Vacation Messages

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

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:

• Discover if their server supports vacation messages.
• Retrieve their current vacation settings.
• Set new vacation settings.
• Remove vacation settings.

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

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

 

<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'/>
    ...
  </query>
</iq>
 

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

<iq type='result' id='get1'>
  <query xmlns='http://www.jabber.org/protocol/vacation'>
    <start>2003-07-06T10:30:00+10:00</start>
    <end>2003-07-13T08:00:00+10:00</end>
    <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>
  </query>
</iq>
 

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

<iq type='set' id='set1'>
  <query xmlns='http://www.jabber.org/protocol/vacation'>
    <start>2003-07-06T10:30:00+10:00</start>
    <end>2003-07-13T08:00:00+10:00</end>
    <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>
  </query>
</iq>
 

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

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

<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:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='http://jabber.org/protocol/vacation'
    xmlns='http://jabber.org/protocol/vacation'
    elementFormDefault='qualified'>

  <xs:element name='query'>
    <xs:complexType>
      <xs:sequence>
        <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:sequence>
    </xs:complexType>
  </xs:element>

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

</xs:schema>
  

Appendices

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

Appendix C: Legal Notices

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

Appendix H: Revision History

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

END