DBus Desktop Notifications

Overview

• Image Support: Yes
• Attachment Support: No
• Message Character Limits:
  • Body: 250

Account Setup

Display notifications right on your Gnome or KDE desktop. This only works if you’re sending the notification to the same system you’re currently accessing. Hence this notification can not be sent from one PC to another.

This plugin was based on lower level calls similar to how the notify-send tool works that ships with some Linux distributions. It taps into the Desktop Bus (DBus) and directly writes the message for QT and GLib Desktop notifications.

Syntax

There are currently no options you can specify for this kind of notification, so it’s really easy to reference.

Valid syntax is as follows:

• dbus://
  • This is the probably best use of this plugin as it will attempt to connect to a QT DBus (usually KDE based) if it can, otherwise it will secondly try to connect to a glib DBus (usually Gnome/Unity based).
• qt://
  • This will explicitly only attempt to access the QT DBus (even if the GLib one is present).
• kde://
  • This is just an alias to qt:// for simplicity purposes. Like qt://, this explicitly only attempt to access the QT DBus (even if the GLib one is present).
• glib://
  • This will explicitly only attempt to access the GLib DBus (even if the QT one is present). A gnome:// alias was not created as Gnome support is already handled using a more mature/newer approach defined [[here|Notify_gnome]].

Parameter Breakdown

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

Assuming we’re on an OS that allows us to host the Gnome Desktop, we can send a notification to ourselves like so:

# Send ourselves a DBus related desktop notification
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   dbus://