XMPP Notifications

Service End Reason

XMPP Support was removed due to incompatibility with the sleekxmpp dependency and Apprise. A Pull Request to restore this functionality is currently in development.

💡The Service was removed from Apprise in apprise/619

Overview

• Source: https://xmpp.org/
• Image Support: No
• Attachment Support: No
• Message Character Limits:
  • Body: 32768

Account Setup

XMPP Support requires sleekxmpp to work:

pip install sleekxmpp

Syntax

Valid syntax is as follows:

• xmpp://{user}/{password}@{hostname}
• xmpps://{user}/{password}@{hostname}
• xmpp://{user}/{password}@{hostname}/{jid}
• xmpp://{user}/{password}@{hostname}/{jid1}/{jid2}/{jidN}

Secure connections should be referenced using xmpps:// where as insecure connections should be referenced via xmpp://.

Parameter Breakdown

Variable	Required	Description
hostname	Yes	The server XMPP is listening on.
port	No	The port the XMPP server is listening on By default the port is 5222 for xmpp:// and 5223 for the secure xmpps:// references.
userid	No	The account login used to build the JID with if one isn’t specified.
password	Yes	The password associated with the XMPP Server.
jid	No	The JID account to associate/authenticate with the XMPP Server. This is automatically detected/built from the {userid} and {hostname} if it isn’t specified.
xep	No	The XEP specifications to include. By default xep_0030 (Service Discovery) and xep_0199 (XMPP Ping) if nothing is specified.
to	No	The JID to notify

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

Send a XMPP notification to our server listening on port 5223:

# Assuming the xmpp {hostname} is localhost
# Assuming the jid is user@localhost
#  - constructed using {hostname} and {userid}
# Assuming the xmpp {password} is abc123
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   xmpp://user:abc123@localhost