MacOS X Desktop Notifications

Overview

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

Account Setup

Display notifications right on your Mac OS X desktop provided you’re running version 10.8 or higher and have installed terminal-notifier. 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.

# Make sure terminal-notifier is installed into your system
brew install terminal-notifier

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:

• macosx://

You can also choose to set a sound to play (such as default):

• macosx://_/?sound=default

The sound can be set any of the sound names listed in Sound Preferences of your Mac OS.

Parameter Breakdown

Variable	Required	Description
sound	No	The sound can be set any of the sound names listed in Sound Preferences of your Mac OS.
image	No	Associate an image with the message. By default this is enabled.

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

We can send a notification to ourselves like so:

# Send ourselves a MacOS desktop notification
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "macosx://"

# Send ourselves a MacOS desktop notification with the default sound
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "macosx://_/?sound=default"