Skip to content
Back to top
View this page

# XEP-0033: Extended Stanza Addressing

XEP-0033 on xmpp.org

class slixmpp.plugins.xep_0033.XEP_0033(xmpp, config=None)

  XEP-0033: Extended Stanza Addressing

## Stanza elements

class slixmpp.plugins.xep_0033.stanza.Address(xml=None, parent=None)
  address_types = {'bcc', 'cc', 'noreply', 'replyroom', 'replyto', 'to'}
  get_delivered()
  get_jid()
  interfaces: ClassVar[set[str]] = {'delivered', 'desc', 'jid', 'node', 'type', 'uri'}

    The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the `plugin_attrib` value of any registered stanza plugins.

  name: ClassVar[str] = 'address'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  namespace: str = 'http://jabber.org/protocol/address'

    The XML namespace for the element. Given `<foo xmlns="bar" />`, then `namespace = "bar"` should be used. The default namespace is `jabber:client` since this is being used in an XMPP library.

  plugin_attrib: ClassVar[str] = 'address'

    For `ElementBase` subclasses which are intended to be used as plugins, the `plugin_attrib` value defines the plugin name. Plugins may be accessed by using the `plugin_attrib` value as the interface. An example using `plugin_attrib = 'foo'`:

        register_stanza_plugin(Message, FooPlugin)
        msg = Message()
        msg['foo']['an_interface_from_the_foo_plugin']

  set_delivered(delivered)
  set_jid(value)
  set_uri(uri)

class slixmpp.plugins.xep_0033.stanza.Addresses(xml=None, parent=None)
  add_address(atype='to', jid='', node='', uri='', desc='', delivered=False)
  del_addresses()
  del_all()
  del_bcc()
  del_cc()
  del_noreply()
  del_replyroom()
  del_replyto()
  del_to()
  get_addresses()
  get_all()
  get_bcc()
  get_cc()
  get_noreply()
  get_replyroom()
  get_replyto()
  get_to()
  interfaces: ClassVar[set[str]] = {'addresses', 'all', 'bcc', 'cc', 'noreply', 'replyroom', 'replyto', 'to'}

    The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the `plugin_attrib` value of any registered stanza plugins.

  name: ClassVar[str] = 'addresses'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  namespace: str = 'http://jabber.org/protocol/address'

    The XML namespace for the element. Given `<foo xmlns="bar" />`, then `namespace = "bar"` should be used. The default namespace is `jabber:client` since this is being used in an XMPP library.

  plugin_attrib: ClassVar[str] = 'addresses'

    For `ElementBase` subclasses which are intended to be used as plugins, the `plugin_attrib` value defines the plugin name. Plugins may be accessed by using the `plugin_attrib` value as the interface. An example using `plugin_attrib = 'foo'`:

        register_stanza_plugin(Message, FooPlugin)
        msg = Message()
        msg['foo']['an_interface_from_the_foo_plugin']

  plugin_attrib_map: ClassVar[dict[str, type[ElementBase]]] = {'address': <class 'slixmpp.plugins.xep_0033.stanza.Address'>}

    A mapping of the `plugin_attrib` values of registered plugins to their respective classes.

  plugin_iterables: ClassVar[set[type[ElementBase]]] = {<class 'slixmpp.plugins.xep_0033.stanza.Address'>}

    The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with `iterable=True`:

        register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)

    Added in version 1.0-Beta5.

  plugin_overrides: ClassVar[dict[str, str]] = {}

    A map of interface operations to the overriding functions. For example, after overriding the `set` operation for the interface `body`, `plugin_overrides` would be:

        {'set_body': <some function>}

  plugin_tag_map: ClassVar[dict[str, type[ElementBase]]] = {'{http://jabber.org/protocol/address}address': <class 'slixmpp.plugins.xep_0033.stanza.Address'>}

    A mapping of root element tag names (in `'{namespace}elementname'` format) to the plugin classes responsible for them.

  set_addresses(value)
  set_all(value)
  set_bcc(value)
  set_cc(value)
  set_noreply(value)
  set_replyroom(value)
  set_replyto(value)
  set_to(value)

slixmpp.plugins.xep_0033.stanza.del_multi(self)

slixmpp.plugins.xep_0033.stanza.get_multi(self)

slixmpp.plugins.xep_0033.stanza.set_multi(self, value)