<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep xmlns="">
<header>
  <title>MUC Mention Notifications</title>
  <abstract>This specification documents how a user may be informed when they're mentioned in a MUC which they're not currently joined to.</abstract>
  
<legal>
<copyright>This XMPP Extension Protocol is copyright © 1999 – 2024 by the <link url="https://xmpp.org/">XMPP Standards Foundation</link> (XSF).</copyright>
<permissions>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.</permissions>
<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. ##</warranty>
<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.</liability>
<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 &lt;<link url="https://xmpp.org/about/xsf/ipr-policy">https://xmpp.org/about/xsf/ipr-policy</link>&gt; or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).</conformance>
</legal>
  <number>0452</number>
  <status>Experimental</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0001</spec>
    <spec>Etc.</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT_YET_ASSIGNED</shortname>
  
  <author>
    <firstname>JC</firstname>
    <surname>Brand</surname>
    <email>jc@opkode.com</email>
    <jid>jc@opkode.com</jid>
  </author>

  
  <author>
    <firstname>Severino</firstname>
    <surname>Ferrer de la Peñita</surname>
    <email>soul@blastersklan.com</email>
    <jid>soul@blastersklan.com</jid>
  </author>

  
  <author>
    <firstname>Matthew</firstname>
    <surname>Wild</surname>
    <email>mwild1@gmail.com</email>
    <jid>me@matthewwild.co.uk</jid>
  </author>

  <revision>
    <version>0.2.2</version>
    <date>2022-01-11</date>
    <initials>gh/@xnamed</initials>
    <remark>Fix addresses in example</remark>
  </revision>
  <revision>
    <version>0.2.1</version>
    <date>2021-02-12</date>
    <initials>ps</initials>
    <remark>Fix reference to XEP-0297: Stanza Forwarding</remark>
  </revision>
  <revision>
    <version>0.2.0</version>
    <date>2021-02-09</date>
    <initials>jcb</initials>
    <remark>Require nickname registration for notifications to work</remark>
  </revision>
  <revision>
    <version>0.1.0</version>
    <date>2021-01-26</date>
    <initials>XEP Editor (jsc)</initials>
    <remark>Accepted by vote of Council on 2021-01-06.</remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2020-12-17</date>
    <initials>jcb</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>

<section1 topic="Introduction" anchor="intro">
    <p>The <span class="ref"><link url="https://xmpp.org/extensions/xep-0045.html">Multi-User Chat (XEP-0045)</link></span> <note>XEP-0045: Multi-User Chat &lt;<link url="https://xmpp.org/extensions/xep-0045.html">https://xmpp.org/extensions/xep-0045.html</link>&gt;.</note> specification does not provide for a mechanism whereby an user might be informed of being mentioned in a Multi-User Chat (MUC) without being present as an occupant of that MUC.</p>
    <p>This XEP aims to provide a standardized way in which this might be achieved.</p>
    <p>Concerning "being mentioned" in a MUC, we will rely on <span class="ref"><link url="https://xmpp.org/extensions/xep-0372.html">References (XEP-0372)</link></span> <note>XEP-0372: References &lt;<link url="https://xmpp.org/extensions/xep-0372.html">https://xmpp.org/extensions/xep-0372.html</link>&gt;.</note> as the means whereby someone is explicitly mentioned in a MUC message.</p>
</section1>

<section1 topic="Requirements" anchor="reqs">
  <p>A user's client must be able to receive forwarded groupchat messages from a MUC in which that user is mentioned, while not having an active session in that MUC (i.e. without joining it).</p>
  <p>For this to be possible, the MUC needs to know the user's JID and MUC nickname even when that user is not currently present in the MUC. <span class="ref"><link url="https://xmpp.org/extensions/xep-0045.html">Multi-User Chat (XEP-0045)</link></span> <note>XEP-0045: Multi-User Chat &lt;<link url="https://xmpp.org/extensions/xep-0045.html">https://xmpp.org/extensions/xep-0045.html</link>&gt;.</note> section 7.10 ("Registering with a Room") describes a mechanism whereby a user can register a nickname with a MUC and it is recommended that this is the mechanism used to keep track of users across sessions.</p>
  <p>Whether or not mesages are forwarded will be determined by a configuration setting on the MUC.</p>
  <p>The MUC owner(s) will therefore determine whether notifications are sent out, and if activated, users may opt in or out (or have that done for them by a privileged user) by having their nicknames registered or not with the MUC.</p>
</section1>

<section1 topic="Use Cases" anchor="usecases">

  <section2 topic="A MUC is configured to send out mention notifications">
    <p>When an owner creates or configures a MUC, the service offers the option to send out mention notifications to non-present, but still affiliated users:</p>
    <example caption="Service Sends Configuration Form"><![CDATA[
<iq from='coven@chat.shakespeare.lit'
    id='create1'
    to='crone1@shakespeare.lit/desktop'
    type='result'>
  <query xmlns='http://jabber.org/protocol/muc#owner'>
    <x xmlns='jabber:x:data' type='form'>
      <field type='hidden' var='FORM_TYPE'>
        <value>http://jabber.org/protocol/muc#roomconfig</value>
      </field>
      ...
      <field
          label='Forward messages with mentions to non-present, affiiated users'
          type='boolean'
          var='muc#roomconfig_forwardmentions'>
        <value>0</value>
      </field>
      ...
    </x>
  </query>
</iq>
]]></example>
    <p>The owner specifies a value of "1" or "true" <note>In accordance with Section 3.2.2.1 of <cite>XML Schema Part 2: Datatypes</cite>, the allowable lexical representations for the xs:boolean datatype are the strings "0" and "false" for the concept 'false' and the strings "1" and "true" for the concept 'true'; implementations MUST support both styles of lexical representation.</note> if the feature is desired:</p>
    <example caption="MUC Owner Submits Configuration Form"><![CDATA[
<iq from='crone1@shakespeare.lit/desktop'
    id='configure1'
    to='coven@chat.shakespeare.lit'
    type='set'>
  <query xmlns='http://jabber.org/protocol/muc#owner'>
    <x xmlns='jabber:x:data' type='submit'>
      <field type='hidden' var='FORM_TYPE'>
        <value>http://jabber.org/protocol/muc#roomconfig</value>
      </field>
      ...
      <field var='muc#roomconfig_forwardmentions'>
        <value>true</value>
      </field>
      ...
    </x>
  </query>
</iq>
]]></example>
    <p/>
  </section2>

  <section2 topic="Notifying a non-present user of being mentioned in a MUC">
    <p>When an affiliated user in a given MUC is referenced in a 'groupchat' message via <span class="ref"><link url="https://xmpp.org/extensions/xep-0372.html">References (XEP-0372)</link></span> <note>XEP-0372: References &lt;<link url="https://xmpp.org/extensions/xep-0372.html">https://xmpp.org/extensions/xep-0372.html</link>&gt;.</note>, and the MUC is configured to forward mentions, then the MUC will forward the message stanza to the user.</p>
    <example caption="MUC forwards the message to the users client"><![CDATA[
<message to='hag66@shakespeare.lit' from='coven@chat.shakespeare.lit'>
  <mentions xmlns='urn:xmpp:mmn:0'>
    <forwarded xmlns='urn:xmpp:forward:0'>
      <delay xmlns='urn:xmpp:delay' stamp='2020-12-03T14:45:56Z'/>
      <message type='groupchat' id='ad22c55c-5a20-4185-8735-af2eb8d459a9'
          to='coven@chat.shakespeare.lit'
          from='coven@chat.shakespeare.lit/firstwitch'
          xml:lang='en'>
        <body>secondwitch: Thrice the brinded cat hath mew'd.</body>
        <reference xmlns='urn:xmpp:reference:0'
            type='mention'
            begin='0'
            uri='xmpp:hag66@shakespeare.lit'
            end='11'/>
        <stanza-id xmlns='urn:xmpp:sid:0'
                   id='5f3dbc5e-e1d3-4077-a492-693f3769c7ad'
                   by='coven@chat.shakespeare.lit'/>
      </message>
    </forwarded>
  </mentions>
</message>
]]></example>
    <p>Notice that in the example above, the entire original 'groupchat' message (including elements added server-side, like the <span class="ref"><link url="https://xmpp.org/extensions/xep-0359.html">Unique and Stable Stanza IDs (XEP-0359)</link></span> <note>XEP-0359: Unique and Stable Stanza IDs &lt;<link url="https://xmpp.org/extensions/xep-0359.html">https://xmpp.org/extensions/xep-0359.html</link>&gt;.</note> stanza-id) is encapsulated inside a <span class="ref"><link url="https://xmpp.org/extensions/xep-0297.html">Stanza Forwarding (XEP-0297)</link></span> <note>XEP-0297: Stanza Forwarding &lt;<link url="https://xmpp.org/extensions/xep-0297.html">https://xmpp.org/extensions/xep-0297.html</link>&gt;.</note> element.</p>
  </section2>
</section1>

<section1 topic="Security Considerations" anchor="security">
  <p>Similarly to <span class="ref"><link url="https://xmpp.org/extensions/xep-0280.html">Message Carbons (XEP-0280)</link></span> <note>XEP-0280: Message Carbons &lt;<link url="https://xmpp.org/extensions/xep-0280.html">https://xmpp.org/extensions/xep-0280.html</link>&gt;.</note>, the security model assumed by this document is that all of the resources for a single user are in the same trust boundary.</p>
  <p>Forwarded groupchat messages leak information of who is currently present in a MUC without requiring the user to join the MUC first to find out.</p>
  <ul>
    <li>Any forwarded copies received by a client MUST be from a valid MUC JID which matches the MUC JID of the encapsulated, forwarded mesages;</li>
    <li>any copies that do not meet this requirement MUST be ignored.</li>
  </ul>
</section1>
<section1 topic="IANA Considerations" anchor="iana">
  <p>None.</p>
</section1>
<section1 topic="XMPP Registrar Considerations" anchor="registrar">
  <section2 topic="Protocol Namespaces" anchor="ns">
    <p>The <span class="ref"><link url="https://xmpp.org/registrar/">XMPP Registrar</link></span> <note>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 &lt;<link url="https://xmpp.org/registrar/">https://xmpp.org/registrar/</link>&gt;.</note> includes 'urn:xmpp:mmn:0' in its registry of protocol namespaces (see &lt;<link url="https://xmpp.org/registrar/namespaces.html">https://xmpp.org/registrar/namespaces.html</link>&gt;).</p>
    <ul>
      <li>urn:xmpp:mmn:0</li>
    </ul>
  </section2>
  <section2 topic="Protocol Versioning" anchor="registrar-versioning">
    <p>If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of <cite>XEP-0053</cite>.</p>
  </section2>
</section1>
</xep>
