xeps/xep-0109.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Vacation Messages</title>
  <abstract>A protocol for setting up vacation messages in Jabber.</abstract>
  &LEGALNOTICE;
  <number>0109</number>
  <status>Deferred</status>
  <type>Informational</type>
  <sig>Standards</sig>
  <dependencies>XEP-0030, XEP-0082</dependencies>
  <supersedes>None</supersedes>
  <supersededby>None</supersededby>
  <shortname>vacation</shortname>
  <author>
    <firstname>Robert</firstname>
    <surname>Norris</surname>
    <email>rob@cataclysm.cx</email>
    <jid>rob@cataclysm.cx</jid>
  </author>
  <revision>
    <version>0.2</version>
    <date>2003-08-12</date>
    <initials>rn</initials>
    <remark>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.</remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2003-07-28</date>
    <initials>rn</initials>
    <remark>Initial version.</remark>
  </revision>
</header>

<section1 topic='Introduction'>
  <p>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.</p>
  <p>This document describes a similar system that allows Jabber users to setup vacation messages when they are away.</p>
</section1>

<section1 topic='Requirements'>
  <p>The requirements for this document are fairly straightforward. A user MUST be able to:</p>

  <ul>
    <li>Discover if their server supports vacation messages.</li>
    <li>Retrieve their current vacation settings.</li>
    <li>Set new vacation settings.</li>
    <li>Remove vacation settings.</li>
  </ul>

  <p>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.</p>

</section1>

<section1 topic='Use cases'>

  <section2 topic='Discovering support for vacation messages'>

    <p>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 &xep0030; "#info" query to their server. If supported, the server includes a feature of "http://www.jabber.org/protocol/vacation" in the result.</p>

    <example caption='Discovering support for vacation messages'><![CDATA[
<iq type='get' to='cataclysm.cx' id='disco1'>
  <query xmlns='http://www.jabber.org/protocol/disco#info'/>
</iq>

 ]]></example>
    <example caption='Discovery response'><![CDATA[
<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>
 ]]></example>

  </section2>

  <section2 topic='Retrieving the current vacation settings'>

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

    <example caption='Retrieving the current vacation settings'><![CDATA[
<iq type='get' id='get1'>
  <query xmlns='http://www.jabber.org/protocol/vacation'/>
</iq>
 ]]></example>

    <example caption='Server returns vacation settings'><![CDATA[
<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>
 ]]></example>

    <p>&lt;start/> and &lt;end/> define the times between which this vacation message is valid. These are in the format specified by &xep0082;.</p>
    <p>&lt;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.</p>

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

    <example caption='User does not have any vacation settings'><![CDATA[
<iq type='result' id='get1'/>
 ]]></example>
  
  </section2>

  <section2 topic='Setting new vacation settings'>

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

    <example caption='Setting new vacation settings'><![CDATA[
<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>
 ]]></example>

   <example caption='Vacation settings set successfully'><![CDATA[
<iq type='result' id='set1'/>
 ]]></example>

    <p>The meaning of each element is as outlined above. All elements are required.</p>

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

  </section2>

  <section2 topic='Removing vacation settings'>

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

    <example caption='Remove vacation settings'><![CDATA[
<iq type='set' id='set2'>
  <query xmlns='http://www.jabber.org/protocol/vacation'/>
</iq>
 ]]></example>

   <example caption='Vacation settings removed successfully'><![CDATA[
<iq type='result' id='set2'/>
 ]]></example>

  </section2>

</section1>

<section1 topic='Server requirements'>
  <p>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.</p>

  <p>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.</p>
</section1>
<section1 topic='Security Considerations'>
  <p>None yet defined.</p>
</section1>
<section1 topic='IANA Considerations'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>
<section1 topic='XMPP Registrar Considerations'>
  <p>The 'http://jabber.org/protocol/vacation' namespace shall be registered with the &REGISTRAR; as a result of this document.</p>
</section1>

<section1 topic='XML Schema'>
  <code><![CDATA[
<?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>
  ]]></code>
</section1>

</xep>