No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

xep-0109.xml 12KB

  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <!DOCTYPE xep SYSTEM 'xep.dtd' [
  3. <!ENTITY % ents SYSTEM 'xep.ent'>
  4. %ents;
  5. ]>
  6. <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
  7. <xep>
  8. <header>
  9. <title>Out-of-Office Messages</title>
  10. <abstract>This document defines an XMPP protocol extension for communicating out-of-office status.</abstract>
  12. <number>0109</number>
  13. <status>Deferred</status>
  14. <type>Standards Track</type>
  15. <sig>Standards</sig>
  16. <dependencies>
  17. <spec>XEP-0060</spec>
  18. <spec>XEP-0163</spec>
  19. </dependencies>
  20. <supersedes/>
  21. <supersededby/>
  22. <shortname>ooo</shortname>
  23. <author>
  24. <firstname>Darrell</firstname>
  25. <surname>Piner</surname>
  26. <email></email>
  27. <jid></jid>
  28. </author>
  29. <author>
  30. <firstname>Robert</firstname>
  31. <surname>Norris</surname>
  32. <email></email>
  33. <jid></jid>
  34. </author>
  35. <revision>
  36. <version>0.3</version>
  37. <date>2010-05-24</date>
  38. <initials>rdp</initials>
  39. <remark>Modified specification to use PEP instead of a dedicated protocol; streamlined use cases; changed namespace to urn:xmpp:ooo:0.</remark>
  40. </revision>
  41. <revision>
  42. <version>0.2</version>
  43. <date>2003-08-12</date>
  44. <initials>rn</initials>
  45. <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>
  46. </revision>
  47. <revision>
  48. <version>0.1</version>
  49. <date>2003-07-28</date>
  50. <initials>rn</initials>
  51. <remark>Initial version.</remark>
  52. </revision>
  53. </header>
  54. <section1 topic='Introduction'>
  55. <p>Popular electronic mail systems include features allowing users to set up
  56. automated messages that are returned to message senders when the user is not
  57. able to deal with the message immediately. This feature is commonly known as
  58. "out-of-office" or "vacation" messages, because it is most commonly used when
  59. a user is unable to read their messages because they are out of the office
  60. (e.g., on vacation).</p>
  61. <p>This document describes a similar system that enables XMPP users to setup
  62. out-of-office messages when they are away.</p>
  63. <p>The basis for the e-mail system mechanism is considering an incoming
  64. message at the server level and determining whether to respond with a canned
  65. out-of-office message. While a system may send a response for each incoming
  66. message, many systems provide an optimization where a response to subsequent
  67. e-mail messages is sent after some period of time expires.</p>
  68. </section1>
  69. <section1 topic='Requirements'>
  70. <p>The requirements for this feature are fairly straightforward. A user MUST be able to:</p>
  71. <ul>
  72. <li>Retrieve their current out-of-office settings.</li>
  73. <li>Set new out-of-office settings.</li>
  74. <li>Remove out-of-office settings.</li>
  75. <li>Notify interested parties of the out-of-office settings when it
  76. is in effect.</li>
  77. </ul>
  78. <p>All these requirements are satisfied by &xep0163;, which is a subset of &xep0060;.</p>
  79. </section1>
  80. <section1 topic='Format'>
  81. <p>The out-of-office setting contains a start-time, an end-time and a
  82. short message text.</p>
  83. <example caption="Sample Out-of-Office message"><![CDATA[
  84. <start>2003-07-06T10:30:00+10:00</start>
  85. <end>2003-07-13T08:00:00+10:00</end>
  86. <message>I'm attending OSCON in sunny Portland and won't be able to
  87. read your message until I get back. If its urgent, please
  88. send email to</message>
  89. ]]></example>
  90. <p>The start and end times are informational only; i.e., the server does
  91. nothing with these values other than store them. PEP does not include node
  92. lifetime management (i.e., start and end times for the node); therefore, the server is unable
  93. to enforce any start and end times included in the settings.</p>
  94. <p>Using the PEP mechanism a client creates
  95. out-of-office settings on a PEP node with the desired access model (such as Presence or Open). When
  96. a user (or their client) sends presence containing CAPS (see &xep0115;) with an
  97. entry for out-of-office to a contact with an out-of-office message, the user's
  98. client is notified of the out-of-office message and may display, in a client-defined
  99. fashion, the out-of-office settings information.</p>
  100. <p>Clients may rely on the PEP node for notifications of changes as well as
  101. automatic notification when the user logs-in (i.e., a user is notified of the
  102. current item on the out-of-office PEP node of another user on sending initial
  103. presence).</p>
  104. </section1>
  105. <section1 topic='Use cases'>
  106. <section2 topic='Retrieving the current out-of-office settings'>
  107. <p>A user may request their current out-of-office message by sending an IQ get to the local server like so:</p>
  108. <example caption='Retrieving the current out-of-office settings'><![CDATA[
  109. <iq type='get'
  110. from=''
  111. to=''
  112. id='get1'>
  113. <pubsub xmlns=''>
  114. <items node='urn:xmpp:ooo:0'/>
  115. </pubsub>
  116. </iq>
  117. ]]></example>
  118. <example caption='Server returns out-of-office settings'><![CDATA[
  119. <iq type='result'
  120. from=''
  121. id='get1'>
  122. <pubsub xmlns='>
  123. <items node='urn:xmpp:ooo:0>
  124. <item id='current'>
  125. <ooo xmlns='urn:xmpp:ooo:0'>
  126. <start>2003-07-06T10:30:00+10:00</start>
  127. <end>2003-07-13T08:00:00+10:00</end>
  128. <message>I'm attending OSCON in sunny Portland and won't be able to
  129. read your message until I get back. If its urgent, please
  130. send email to</message>
  131. </ooo>
  132. </item>
  133. </items>
  134. </pubsub>
  135. </iq>
  136. ]]></example>
  137. <p>The &lt;start/> and &lt;end/> elements define the times between which this vacation
  138. message should be considered valid by a supporting client; the times are in
  139. the format specified by &xep0082;.</p>
  140. <p>The &lt;message/> element contains the text of the message which the client may
  141. display for the user (when appropriate).</p>
  142. <p>If the user has no stored vacation message, the user will receive a
  143. result like the following:</p>
  144. <example caption='User does not have any out-of-office settings'><![CDATA[
  145. <iq type='result' id='get1'/>
  146. ]]></example>
  147. </section2>
  148. <section2 topic='Publishing new out-of-office settings'>
  149. <p>A user may set new vacation message by publishing a new item with an id
  150. of 'current' to the out-of-office node:</p>
  151. <example caption='Publishing new out-of-office settings'><![CDATA[
  152. <iq type='set'
  153. from=''
  154. to=''
  155. id='publish1'>
  156. <pubsub xmlns=''>
  157. <publish node='urn:xmpp:ooo:0'>
  158. <item id='current'>
  159. <ooo xmlns='urn:xmpp:ooo:0'>
  160. <start>2003-07-06T10:30:00+10:00</start>
  161. <end>2003-07-13T08:00:00+10:00</end>
  162. <message>I'm attending OSCON in sunny Portland and won't be able to
  163. read your message until I get back. If its urgent, please
  164. send email to</message>
  165. </ooo>
  166. </item>
  167. </publish>
  168. </pubsub>
  169. </iq>
  170. ]]></example>
  171. <example caption='Out-of-office settings published successfully'><![CDATA[
  172. <iq type='result'
  173. from=''
  174. to=''
  175. id='publish1'>
  176. <pubsub xmlns=''>
  177. <publish node='urn:xmpp:ooo:0'>
  178. <item id='current'>
  179. <ooo xmlns='urn:xmpp:ooo:0'>
  180. <start>2003-07-06T10:30:00+10:00</start>
  181. <end>2003-07-13T08:00:00+10:00</end>
  182. <message>I'm attending OSCON in sunny Portland and won't be able to
  183. read your message until I get back. If its urgent, please
  184. send email to</message>
  185. </ooo>
  186. </item>
  187. </publish>
  188. </pubsub>
  189. </iq>
  190. ]]></example>
  191. <p>And by design, PEP sends a notification to all the user's resources.</p>
  192. <example caption="PEP node notification sent to user"><![CDATA[
  193. <message from=''
  194. id='notification_1781477179'
  195. to='' type='headline'>
  196. <event xmlns=''>
  197. <items node='urn:xmpp:ooo:0'>
  198. <item id='current'>
  199. <ooo xmlns='urn:xmpp:ooo:0'>
  200. <start>2003-07-06T10:30:00+10:00</start>
  201. <end>2003-07-13T08:00:00+10:00</end>
  202. <message>I'm attending OSCON in sunny Portland and won't be able to
  203. read your message until I get back. If its urgent, please
  204. send email to</message>
  205. </ooo>
  206. </item>
  207. </items>
  208. </event>
  209. </message>
  210. ]]></example>
  211. <p>The meaning of each element is as outlined above. All elements are required.</p>
  212. <p>Additionally, the &lt;start/> and &lt;end/> elements MAY be empty (i.e.,
  213. have no CDATA). When &lt;start/> is empty, the client MUST take this to mean
  214. that the settings should take effect immediately. Similarly, when &lt;end/>
  215. is empty, the client MUST take this to mean that the settings should never
  216. expire (unless they are explicitly removed).</p>
  217. </section2>
  218. <section2 topic='Removing out-of-office settings'>
  219. <p>A user may remove all stored vacation settings by sending an IQ to the local server like so:</p>
  220. <example caption='Remove vacation settings'><![CDATA[
  221. <iq type='set'
  222. from=''
  223. to=''
  224. it='retract1'>
  225. <pubsub xmlns=''>
  226. <retract node='urn:xmpp:ooo:0'>
  227. <item id='current' />
  228. </retract>
  229. </pubsub>
  230. </iq>
  231. ]]></example>
  232. <example caption='Vacation settings removed successfully'><![CDATA[
  233. <iq type='result'
  234. from=''
  235. to=''
  236. id='retract1' />
  237. ]]></example>
  238. <p>TODO: Is the Delete And Notify functionality described in XEP-0060
  239. widely implemented? If so, should that case be included here?</p>
  240. </section2>
  241. <section2 topic='Hiding vacation settings'>
  242. <p>In PEP, a node's default access model is 'presence' (i.e., any other user
  243. with a subscription type "from" or "both" may subscribe to the node. PEP
  244. provides other access models including a 'whitelist.' See &xep0060; section
  245. 4.5 for a list of Node Access Models.</p>
  246. <p>The whitelist access model can be used to hide the current
  247. out-of-office message. With an empty whitelist, no other users
  248. receive notification when the node changes. The client may also use this
  249. fact to allow the client's user to set up an out-of-office message
  250. before it becomes active.</p>
  251. <p>See &xep0060; Section 8.2 for details on configuration the out-of-office
  252. node's access model.</p>
  253. <p>See also &xep0223;.</p>
  254. <p>PEP and PubSub allow for publishing an item and setting configuration on
  255. a node. A user may wish to create an initial, hidden out-of-office
  256. setting. They may do so by publishing an item with id='archive' and an
  257. access model of 'whitelist.' When the user enables the
  258. out-of-office settings, a configuration changing the access model
  259. to some other mode sends notifications as defined by PEP.</p>
  260. <p>TODO: add an example of publishing an item and setting configuration with
  261. a single stanza i.e., find the appropriate example from &xep0060; or
  262. &xep0163; and include it here.</p>
  263. </section2>
  264. </section1>
  265. <section1 topic='Server requirements'>
  266. <p>A server implementing out-of-office messages MUST implement
  267. &xep0163;.</p>
  268. </section1>
  269. <section1 topic='Security Considerations'>
  270. <p>None yet defined.</p>
  271. </section1>
  272. <section1 topic='IANA Considerations'>
  273. <p>This document requires no interaction with &IANA;.</p>
  274. </section1>
  275. <section1 topic='XMPP Registrar Considerations'>
  276. <p>The 'urn:xmpp:ooo:0' namespace shall be registered with the &REGISTRAR; as a result of this document.</p>
  277. </section1>
  278. <section1 topic='XML Schema'>
  279. <code><![CDATA[
  280. <?xml version='1.0' encoding='UTF-8'?>
  281. <xs:schema
  282. xmlns:xs=''
  283. targetNamespace='urn:xmpp:ooo:0'
  284. xmlns='urn:xmpp:ooo:0'
  285. elementFormDefault='qualified'>
  286. <xs:element name='item'>
  287. <xs:complexType>
  288. <xs:sequence>
  289. <xs:element name='start' minOccurs='0' maxOccurs='1' type='xs:string'/>
  290. <xs:element name='end' minOccurs='0' maxOccurs='1' type='xs:string'/>
  291. <xs:element name='message' minOccurs='0' maxOccurs='1' type='xs:string'/>
  292. </xs:sequence>
  293. </xs:complexType>
  294. </xs:element>
  295. </xs:schema>
  296. ]]></code>
  297. </section1>
  298. </xep>