mirror of https://github.com/caronc/apprise
parent
a0328274f3
commit
6dafecdb19
|
@ -27,7 +27,7 @@
|
||||||
# POSSIBILITY OF SUCH DAMAGE.
|
# POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
__title__ = 'Apprise'
|
__title__ = 'Apprise'
|
||||||
__version__ = '1.8.0'
|
__version__ = '1.8.1'
|
||||||
__author__ = 'Chris Caron'
|
__author__ = 'Chris Caron'
|
||||||
__license__ = 'BSD'
|
__license__ = 'BSD'
|
||||||
__copywrite__ = 'Copyright (C) 2024 Chris Caron <lead2gold@gmail.com>'
|
__copywrite__ = 'Copyright (C) 2024 Chris Caron <lead2gold@gmail.com>'
|
||||||
|
|
|
@ -6,16 +6,16 @@
|
||||||
#, fuzzy
|
#, fuzzy
|
||||||
msgid ""
|
msgid ""
|
||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: apprise 1.8.0\n"
|
"Project-Id-Version: apprise 1.8.1\n"
|
||||||
"Report-Msgid-Bugs-To: lead2gold@gmail.com\n"
|
"Report-Msgid-Bugs-To: lead2gold@gmail.com\n"
|
||||||
"POT-Creation-Date: 2024-05-11 16:13-0400\n"
|
"POT-Creation-Date: 2024-07-25 18:31-0400\n"
|
||||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||||
"MIME-Version: 1.0\n"
|
"MIME-Version: 1.0\n"
|
||||||
"Content-Type: text/plain; charset=utf-8\n"
|
"Content-Type: text/plain; charset=utf-8\n"
|
||||||
"Content-Transfer-Encoding: 8bit\n"
|
"Content-Transfer-Encoding: 8bit\n"
|
||||||
"Generated-By: Babel 2.13.1\n"
|
"Generated-By: Babel 2.15.0\n"
|
||||||
|
|
||||||
msgid "A local Gnome environment is required."
|
msgid "A local Gnome environment is required."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
@ -35,6 +35,9 @@ msgstr ""
|
||||||
msgid "API Token"
|
msgid "API Token"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "API Version"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Access Key"
|
msgid "Access Key"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -56,6 +59,9 @@ msgstr ""
|
||||||
msgid "Action"
|
msgid "Action"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Action Mapping"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Add Tokens"
|
msgid "Add Tokens"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -74,6 +80,9 @@ msgstr ""
|
||||||
msgid "App ID"
|
msgid "App ID"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "App User Name"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "App Version"
|
msgid "App Version"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -182,6 +191,9 @@ msgstr ""
|
||||||
msgid "Currency"
|
msgid "Currency"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Custom Data"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Custom Details"
|
msgid "Custom Details"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -200,6 +212,9 @@ msgstr ""
|
||||||
msgid "Data Entries"
|
msgid "Data Entries"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Decode Template Args"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Delay"
|
msgid "Delay"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -242,9 +257,15 @@ msgstr ""
|
||||||
msgid "Embed URL"
|
msgid "Embed URL"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Enable Contents"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Entity"
|
msgid "Entity"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Entity ID"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Event"
|
msgid "Event"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -284,6 +305,9 @@ msgstr ""
|
||||||
msgid "Free-Mobile"
|
msgid "Free-Mobile"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "From"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "From Email"
|
msgid "From Email"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -398,6 +422,9 @@ msgstr ""
|
||||||
msgid "Matrix API Verion"
|
msgid "Matrix API Verion"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Media Type"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Memory"
|
msgid "Memory"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -478,15 +505,12 @@ msgstr ""
|
||||||
msgid "Payload Extras"
|
msgid "Payload Extras"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
msgid "Ping Discord Role"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
msgid "Ping Discord User"
|
|
||||||
msgstr ""
|
|
||||||
|
|
||||||
msgid "Port"
|
msgid "Port"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Postback Data"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Prefix"
|
msgid "Prefix"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -511,6 +535,9 @@ msgstr ""
|
||||||
msgid "Query Method"
|
msgid "Query Method"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Recipient Phone Number"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Region"
|
msgid "Region"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -541,6 +568,9 @@ msgstr ""
|
||||||
msgid "Route Group"
|
msgid "Route Group"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "SMS Mode"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "SMTP Server"
|
msgid "SMTP Server"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -571,6 +601,9 @@ msgstr ""
|
||||||
msgid "Sender ID"
|
msgid "Sender ID"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Sender Name"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Sensitive Attachments"
|
msgid "Sensitive Attachments"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -580,6 +613,12 @@ msgstr ""
|
||||||
msgid "Server Timeout"
|
msgid "Server Timeout"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Service ID"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Service Password"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Severity"
|
msgid "Severity"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -589,9 +628,15 @@ msgstr ""
|
||||||
msgid "Show Status"
|
msgid "Show Status"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Signature"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Silent Notification"
|
msgid "Silent Notification"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Société Française du Radiotéléphone"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Socket Connect Timeout"
|
msgid "Socket Connect Timeout"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -613,9 +658,15 @@ msgstr ""
|
||||||
msgid "Source Phone No"
|
msgid "Source Phone No"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Space ID"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Special Text Color"
|
msgid "Special Text Color"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Splunk On-Call"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Spoiler Text"
|
msgid "Spoiler Text"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -625,6 +676,9 @@ msgstr ""
|
||||||
msgid "Subtitle"
|
msgid "Subtitle"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "TTS Voice"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Tags"
|
msgid "Tags"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -667,6 +721,9 @@ msgstr ""
|
||||||
msgid "Target Group ID"
|
msgid "Target Group ID"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Target Phone"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Target Phone No"
|
msgid "Target Phone No"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -682,6 +739,9 @@ msgstr ""
|
||||||
msgid "Target Room ID"
|
msgid "Target Room ID"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Target Routing Key"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Target Schedule"
|
msgid "Target Schedule"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -757,6 +817,9 @@ msgstr ""
|
||||||
msgid "Thread Key"
|
msgid "Thread Key"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Timeout"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "To Channel ID"
|
msgid "To Channel ID"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
@ -862,9 +925,15 @@ msgstr ""
|
||||||
msgid "Webhook Token"
|
msgid "Webhook Token"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Workflow ID"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "Workspace"
|
msgid "Workspace"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
msgid "Wrap Text"
|
||||||
|
msgstr ""
|
||||||
|
|
||||||
msgid "X-Axis"
|
msgid "X-Axis"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
|
|
@ -1,213 +1,134 @@
|
||||||
.\" generated with Ronn/v0.7.3
|
.\" generated with Ronn-NG/v0.9.1
|
||||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
.\" http://github.com/apjanke/ronn-ng/tree/0.9.1
|
||||||
.
|
.TH "APPRISE" "1" "July 2024" "Chris Caron <lead2gold@gmail.com>"
|
||||||
.TH "APPRISE" "1" "March 2024" "Chris Caron <lead2gold@gmail.com>" ""
|
|
||||||
.
|
|
||||||
.SH "NAME"
|
.SH "NAME"
|
||||||
\fBapprise\fR \- Push Notifications that work with just about every platform!
|
\fBapprise\fR \- Push Notifications that work with just about every platform!
|
||||||
.
|
|
||||||
.SH "SYNOPSIS"
|
.SH "SYNOPSIS"
|
||||||
\fBapprise\fR [\fIoptions\fR\.\.\.] \fIservice\-url\fR\.\.\.
|
\fBapprise\fR [\fIoptions\fR\|\.\|\.\|\.] \fIservice\-url\fR\|\.\|\.\|\.
|
||||||
.
|
|
||||||
.br
|
.br
|
||||||
.
|
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
\fBApprise\fR allows you to send a notification to \fIalmost all\fR of the most popular notification services available to us today such as: Discord, Telegram, Pushbullet, Slack, Twitter, etc\.
|
\fBApprise\fR allows you to send a notification to \fIalmost all\fR of the most popular notification services available to us today such as: Discord, Telegram, Pushbullet, Slack, Twitter, etc\.
|
||||||
.
|
.IP "\[ci]" 4
|
||||||
.IP "\(bu" 4
|
|
||||||
One notification library to rule them all\.
|
One notification library to rule them all\.
|
||||||
.
|
.IP "\[ci]" 4
|
||||||
.IP "\(bu" 4
|
|
||||||
A common and intuitive notification syntax\.
|
A common and intuitive notification syntax\.
|
||||||
.
|
.IP "\[ci]" 4
|
||||||
.IP "\(bu" 4
|
|
||||||
Supports the handling of images (to the notification services that will accept them)\.
|
Supports the handling of images (to the notification services that will accept them)\.
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.SH "OPTIONS"
|
.SH "OPTIONS"
|
||||||
The Apprise options are as follows:
|
The Apprise options are as follows:
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-b\fR, \fB\-\-body=\fR\fITEXT\fR: Specify the message body\. If no body is specified then content is read from \fIstdin\fR\.
|
\fB\-b\fR, \fB\-\-body=\fR\fITEXT\fR: Specify the message body\. If no body is specified then content is read from \fIstdin\fR\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-t\fR, \fB\-\-title=\fR\fITEXT\fR: Specify the message title\. This field is complete optional\.
|
\fB\-t\fR, \fB\-\-title=\fR\fITEXT\fR: Specify the message title\. This field is complete optional\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-c\fR, \fB\-\-config=\fR\fICONFIG\-URL\fR: Specify one or more configuration locations\.
|
\fB\-c\fR, \fB\-\-config=\fR\fICONFIG\-URL\fR: Specify one or more configuration locations\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-a\fR, \fB\-\-attach=\fR\fIATTACH\-URL\fR: Specify one or more file attachment locations\.
|
\fB\-a\fR, \fB\-\-attach=\fR\fIATTACH\-URL\fR: Specify one or more file attachment locations\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-P\fR, \fB\-\-plugin\-path=\fR\fIPLUGIN\-PATH\fR: Specify a path to scan for custom notification plugin support\. You can create your own notification by simply creating a Python file that contains the \fB@notify("schema")\fR decorator\.
|
\fB\-P\fR, \fB\-\-plugin\-path=\fR\fIPLUGIN\-PATH\fR: Specify a path to scan for custom notification plugin support\. You can create your own notification by simply creating a Python file that contains the \fB@notify("schema")\fR decorator\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
You can optioanly chose to specify more then one \fB\-\-plugin\-path\fR (\fB\-P\fR) to increase the modules included\.
|
You can optioanly chose to specify more then one \fB\-\-plugin\-path\fR (\fB\-P\fR) to increase the modules included\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-n\fR, \fB\-\-notification\-type=\fR\fITYPE\fR: Specify the message type (default=info)\. Possible values are "info", "success", "failure", and "warning"\.
|
\fB\-n\fR, \fB\-\-notification\-type=\fR\fITYPE\fR: Specify the message type (default=info)\. Possible values are "info", "success", "failure", and "warning"\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-i\fR, \fB\-\-input\-format=\fR\fIFORMAT\fR: Specify the input message format (default=text)\. Possible values are "text", "html", and "markdown"\.
|
\fB\-i\fR, \fB\-\-input\-format=\fR\fIFORMAT\fR: Specify the input message format (default=text)\. Possible values are "text", "html", and "markdown"\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-T\fR, \fB\-\-theme=\fRTHEME: Specify the default theme\.
|
\fB\-T\fR, \fB\-\-theme=\fRTHEME: Specify the default theme\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-g\fR, \fB\-\-tag=\fRTAG: Specify one or more tags to filter which services to notify\. Use multiple \fB\-\-tag\fR (\fB\-g\fR) entries to \fBOR\fR the tags together and comma separated to \fBAND\fR them\. If no tags are specified then all services are notified\.
|
\fB\-g\fR, \fB\-\-tag=\fRTAG: Specify one or more tags to filter which services to notify\. Use multiple \fB\-\-tag\fR (\fB\-g\fR) entries to \fBOR\fR the tags together and comma separated to \fBAND\fR them\. If no tags are specified then all services are notified\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-Da\fR, \fB\-\-disable\-async\fR: Send notifications synchronously (one after the other) instead of all at once\.
|
\fB\-Da\fR, \fB\-\-disable\-async\fR: Send notifications synchronously (one after the other) instead of all at once\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-R\fR, \fB\-\-recursion\-depth\fR: he number of recursive import entries that can be loaded from within Apprise configuration\. By default this is set to 1\. If this is set to zero, then import statements found in any configuration is ignored\.
|
\fB\-R\fR, \fB\-\-recursion\-depth\fR: he number of recursive import entries that can be loaded from within Apprise configuration\. By default this is set to 1\. If this is set to zero, then import statements found in any configuration is ignored\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-e\fR, \fB\-\-interpret\-escapes\fR Enable interpretation of backslash escapes\. For example, this would convert sequences such as \en and \er to their respected ascii new\-line and carriage
|
\fB\-e\fR, \fB\-\-interpret\-escapes\fR Enable interpretation of backslash escapes\. For example, this would convert sequences such as \en and \er to their respected ascii new\-line and carriage
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-j\fR, \fB\-\-interpret\-emojis\fR Enable interpretation of emoji strings\. For example, this would convert sequences such as :smile: or :grin: to their respected unicode emoji character\.
|
\fB\-j\fR, \fB\-\-interpret\-emojis\fR Enable interpretation of emoji strings\. For example, this would convert sequences such as :smile: or :grin: to their respected unicode emoji character\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-d\fR, \fB\-\-dry\-run\fR: Perform a trial run but only prints the notification services to\-be triggered to \fBstdout\fR\. Notifications are never sent using this mode\.
|
\fB\-d\fR, \fB\-\-dry\-run\fR: Perform a trial run but only prints the notification services to\-be triggered to \fBstdout\fR\. Notifications are never sent using this mode\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
return characters prior to the delivery of the notification\.
|
return characters prior to the delivery of the notification\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-l\fR, \fB\-\-details\fR Prints details about the current services supported by Apprise\.
|
\fB\-l\fR, \fB\-\-details\fR Prints details about the current services supported by Apprise\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-v\fR, \fB\-\-verbose\fR: The more of these you specify, the more verbose the output is\. e\.g: \-vvvv
|
\fB\-v\fR, \fB\-\-verbose\fR: The more of these you specify, the more verbose the output is\. e\.g: \-vvvv
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-D\fR, \fB\-\-debug\fR: A debug mode; useful for troubleshooting\.
|
\fB\-D\fR, \fB\-\-debug\fR: A debug mode; useful for troubleshooting\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-V\fR, \fB\-\-version\fR: Display the apprise version and exit\.
|
\fB\-V\fR, \fB\-\-version\fR: Display the apprise version and exit\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
\fB\-h\fR, \fB\-\-help\fR: Show this message and exit\.
|
\fB\-h\fR, \fB\-\-help\fR: Show this message and exit\.
|
||||||
.
|
|
||||||
.SH "EXIT STATUS"
|
.SH "EXIT STATUS"
|
||||||
\fBapprise\fR exits with a status of:
|
\fBapprise\fR exits with a status of:
|
||||||
.
|
.IP "\[ci]" 4
|
||||||
.IP "\(bu" 4
|
|
||||||
\fB0\fR if all of the notifications were sent successfully\.
|
\fB0\fR if all of the notifications were sent successfully\.
|
||||||
.
|
.IP "\[ci]" 4
|
||||||
.IP "\(bu" 4
|
|
||||||
\fB1\fR if one or more notifications could not be sent\.
|
\fB1\fR if one or more notifications could not be sent\.
|
||||||
.
|
.IP "\[ci]" 4
|
||||||
.IP "\(bu" 4
|
|
||||||
\fB2\fR if there was an error specified on the command line such as not providing an valid argument\.
|
\fB2\fR if there was an error specified on the command line such as not providing an valid argument\.
|
||||||
.
|
.IP "\[ci]" 4
|
||||||
.IP "\(bu" 4
|
|
||||||
\fB3\fR if there was one or more Apprise Service URLs successfully loaded but none could be notified due to user filtering (via tags)\.
|
\fB3\fR if there was one or more Apprise Service URLs successfully loaded but none could be notified due to user filtering (via tags)\.
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.SH "SERVICE URLS"
|
.SH "SERVICE URLS"
|
||||||
There are to many service URL and combinations to list here\. It\'s best to visit the Apprise GitHub page \fIhttps://github\.com/caronc/apprise/wiki#notification\-services\fR and see what\'s available\.
|
There are to many service URL and combinations to list here\. It\'s best to visit the Apprise GitHub page \fIhttps://github\.com/caronc/apprise/wiki#notification\-services\fR and see what\'s available\.
|
||||||
.
|
|
||||||
.SH "EXAMPLES"
|
.SH "EXAMPLES"
|
||||||
Send a notification to as many servers as you want to specify as you can easily chain them together:
|
Send a notification to as many servers as you want to specify as you can easily chain them together:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
$ apprise \-vv \-t "my title" \-b "my notification body" \e
|
$ apprise \-vv \-t "my title" \-b "my notification body" \e
|
||||||
"mailto://myemail:mypass@gmail\.com" \e
|
"mailto://myemail:mypass@gmail\.com" \e
|
||||||
"pbul://o\.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b"
|
"pbul://o\.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b"
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
If you don\'t specify a \fB\-\-body\fR (\fB\-b\fR) then stdin is used allowing you to use the tool as part of your every day administration:
|
If you don\'t specify a \fB\-\-body\fR (\fB\-b\fR) then stdin is used allowing you to use the tool as part of your every day administration:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
$ cat /proc/cpuinfo | apprise \-vv \-t "cpu info" \e
|
$ cat /proc/cpuinfo | apprise \-vv \-t "cpu info" \e
|
||||||
"mailto://myemail:mypass@gmail\.com"
|
"mailto://myemail:mypass@gmail\.com"
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
Load in a configuration file which identifies all of your notification service URLs and notify them all:
|
Load in a configuration file which identifies all of your notification service URLs and notify them all:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
$ apprise \-vv \-t "my title" \-b "my notification body" \e
|
$ apprise \-vv \-t "my title" \-b "my notification body" \e
|
||||||
\-\-config=~/apprise\.yml
|
\-\-config=~/apprise\.yml
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
Load in a configuration file from a remote server that identifies all of your notification service URLs and only notify the ones tagged as \fIdevops\fR\.
|
Load in a configuration file from a remote server that identifies all of your notification service URLs and only notify the ones tagged as \fIdevops\fR\.
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
$ apprise \-vv \-t "my title" \-b "my notification body" \e
|
$ apprise \-vv \-t "my title" \-b "my notification body" \e
|
||||||
\-\-config=https://localhost/my/apprise/config \e
|
\-\-config=https://localhost/my/apprise/config \e
|
||||||
\-t devops
|
\-t devops
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
Include an attachment:
|
Include an attachment:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
$ apprise \-vv \-t "School Assignment" \-b "See attached" \e
|
$ apprise \-vv \-t "School Assignment" \-b "See attached" \e
|
||||||
\-\-attach=Documents/FinalReport\.docx
|
\-\-attach=Documents/FinalReport\.docx
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.SH "CUSTOM PLUGIN/NOTIFICATIONS"
|
.SH "CUSTOM PLUGIN/NOTIFICATIONS"
|
||||||
Apprise can additionally allow you to define your own custom \fBschema://\fR entries that you can trigger on and call services you\'ve defined\.
|
Apprise can additionally allow you to define your own custom \fBschema://\fR entries that you can trigger on and call services you\'ve defined\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
By default \fBapprise\fR looks in the following local locations for custom plugin files and loads them:
|
By default \fBapprise\fR looks in the following local locations for custom plugin files and loads them:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
~/\.apprise/plugins
|
~/\.apprise/plugins
|
||||||
~/\.config/apprise/plugins
|
~/\.config/apprise/plugins
|
||||||
/var/lib/apprise/plugins
|
/var/lib/apprise/plugins
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
Simply create your own python file with the following bare minimum content in it: from apprise\.decorators import notify
|
Simply create your own python file with the following bare minimum content in it: from apprise\.decorators import notify
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
# This example assumes you want your function to trigger on foobar://
|
# This example assumes you want your function to trigger on foobar://
|
||||||
# references:
|
# references:
|
||||||
@notify(on="foobar", name="My Custom Notification")
|
@notify(on="foobar", name="My Custom Notification")
|
||||||
|
@ -218,21 +139,14 @@ def my_wrapper(body, title, notify_type, *args, **kwargs):
|
||||||
# Returning True/False is a way to relay your status back to Apprise\.
|
# Returning True/False is a way to relay your status back to Apprise\.
|
||||||
# Returning nothing (None by default) is always interpreted as a Success
|
# Returning nothing (None by default) is always interpreted as a Success
|
||||||
return True
|
return True
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.SH "CONFIGURATION"
|
.SH "CONFIGURATION"
|
||||||
A configuration file can be in the format of either \fBTEXT\fR or \fBYAML\fR where [TEXT][textconfig] is the easiest and most ideal solution for most users\. However YAML \fIhttps://github\.com/caronc/apprise/wiki/config_yaml\fR configuration files grants the user a bit more leverage and access to some of the internal features of Apprise\. Reguardless of which format you choose, both provide the users the ability to leverage \fBtagging\fR which adds a more rich and powerful notification environment\.
|
A configuration file can be in the format of either \fBTEXT\fR or \fBYAML\fR where [TEXT][textconfig] is the easiest and most ideal solution for most users\. However YAML \fIhttps://github\.com/caronc/apprise/wiki/config_yaml\fR configuration files grants the user a bit more leverage and access to some of the internal features of Apprise\. Reguardless of which format you choose, both provide the users the ability to leverage \fBtagging\fR which adds a more rich and powerful notification environment\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
Configuration files can be directly referenced via \fBapprise\fR when referencing the \fB\-\-config=\fR (\fB\-c\fR) CLI directive\. You can identify as many as you like on the command line and all of them will be loaded\. You can also point your configuration to a cloud location (by referencing \fBhttp://\fR or \fBhttps://\fR\. By default \fBapprise\fR looks in the following local locations for configuration files and loads them:
|
Configuration files can be directly referenced via \fBapprise\fR when referencing the \fB\-\-config=\fR (\fB\-c\fR) CLI directive\. You can identify as many as you like on the command line and all of them will be loaded\. You can also point your configuration to a cloud location (by referencing \fBhttp://\fR or \fBhttps://\fR\. By default \fBapprise\fR looks in the following local locations for configuration files and loads them:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
~/\.apprise\.conf
|
~/\.apprise\.conf
|
||||||
~/\.apprise\.yaml
|
~/\.apprise\.yaml
|
||||||
~/\.config/apprise\.conf
|
~/\.config/apprise\.conf
|
||||||
|
@ -247,43 +161,26 @@ Configuration files can be directly referenced via \fBapprise\fR when referencin
|
||||||
/etc/apprise\.yaml
|
/etc/apprise\.yaml
|
||||||
/etc/apprise/apprise\.conf
|
/etc/apprise/apprise\.conf
|
||||||
/etc/apprise/apprise\.yaml
|
/etc/apprise/apprise\.yaml
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
The \fBconfiguration files\fR specified above can also be identified with a \fB\.yml\fR extension or even just entirely removing the \fB\.conf\fR extension altogether\.
|
The \fBconfiguration files\fR specified above can also be identified with a \fB\.yml\fR extension or even just entirely removing the \fB\.conf\fR extension altogether\.
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
If a default configuration file is referenced in any way by the \fBapprise\fR tool, you no longer need to provide it a Service URL\. Usage of the \fBapprise\fR tool simplifies to:
|
If a default configuration file is referenced in any way by the \fBapprise\fR tool, you no longer need to provide it a Service URL\. Usage of the \fBapprise\fR tool simplifies to:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
$ apprise \-vv \-t "my title" \-b "my notification body"
|
$ apprise \-vv \-t "my title" \-b "my notification body"
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.P
|
.P
|
||||||
If you leveraged tagging \fIhttps://github\.com/caronc/apprise/wiki/CLI_Usage#label\-leverage\-tagging\fR, you can define all of Apprise Service URLs in your configuration that you want and only specifically notify a subset of them:
|
If you leveraged tagging \fIhttps://github\.com/caronc/apprise/wiki/CLI_Usage#label\-leverage\-tagging\fR, you can define all of Apprise Service URLs in your configuration that you want and only specifically notify a subset of them:
|
||||||
.
|
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
.
|
|
||||||
.nf
|
.nf
|
||||||
|
|
||||||
$ apprise \-vv \-t "Will Be Late" \-b "Go ahead and make dinner without me" \e
|
$ apprise \-vv \-t "Will Be Late" \-b "Go ahead and make dinner without me" \e
|
||||||
\-\-tag=family
|
\-\-tag=family
|
||||||
.
|
|
||||||
.fi
|
.fi
|
||||||
.
|
|
||||||
.IP "" 0
|
.IP "" 0
|
||||||
.
|
|
||||||
.SH "BUGS"
|
.SH "BUGS"
|
||||||
If you find any bugs, please make them known at: \fIhttps://github\.com/caronc/apprise/issues\fR
|
If you find any bugs, please make them known at: \fIhttps://github\.com/caronc/apprise/issues\fR
|
||||||
.
|
|
||||||
.SH "COPYRIGHT"
|
.SH "COPYRIGHT"
|
||||||
Apprise is Copyright (C) 2024 Chris Caron \fIlead2gold@gmail\.com\fR
|
Apprise is Copyright (C) 2024 Chris Caron \fIlead2gold@gmail\.com\fR
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
<meta http-equiv='content-type' content='text/html;charset=utf8'>
|
||||||
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
<meta name='generator' content='Ronn-NG/v0.9.1 (http://github.com/apjanke/ronn-ng/tree/0.9.1)'>
|
||||||
<title>apprise(1) - Push Notifications that work with just about every platform!</title>
|
<title>apprise(1) - Push Notifications that work with just about every platform!</title>
|
||||||
<style type='text/css' media='all'>
|
<style type='text/css' media='all'>
|
||||||
/* style: man */
|
/* style: man */
|
||||||
|
@ -72,14 +72,15 @@
|
||||||
<li class='tr'>apprise(1)</li>
|
<li class='tr'>apprise(1)</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<h2 id="NAME">NAME</h2>
|
<h2 id="NAME">NAME</h2>
|
||||||
<p class="man-name">
|
<p class="man-name">
|
||||||
<code>apprise</code> - <span class="man-whatis">Push Notifications that work with just about every platform!</span>
|
<code>apprise</code> - <span class="man-whatis">Push Notifications that work with just about every platform!</span>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
||||||
|
|
||||||
<p><code>apprise</code> [<var>options</var>...] <var>service-url</var>...<br /></p>
|
<p><code>apprise</code> [<var>options</var>...] <var>service-url</var>...<br></p>
|
||||||
|
|
||||||
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
||||||
|
|
||||||
|
@ -94,7 +95,6 @@ Telegram, Pushbullet, Slack, Twitter, etc.</p>
|
||||||
accept them).</li>
|
accept them).</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2 id="OPTIONS">OPTIONS</h2>
|
<h2 id="OPTIONS">OPTIONS</h2>
|
||||||
|
|
||||||
<p>The Apprise options are as follows:</p>
|
<p>The Apprise options are as follows:</p>
|
||||||
|
@ -180,15 +180,18 @@ accept them).</li>
|
||||||
<p><strong>apprise</strong> exits with a status of:</p>
|
<p><strong>apprise</strong> exits with a status of:</p>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li><strong>0</strong> if all of the notifications were sent successfully.</li>
|
<li>
|
||||||
<li><strong>1</strong> if one or more notifications could not be sent.</li>
|
<strong>0</strong> if all of the notifications were sent successfully.</li>
|
||||||
<li><strong>2</strong> if there was an error specified on the command line such as not
|
<li>
|
||||||
|
<strong>1</strong> if one or more notifications could not be sent.</li>
|
||||||
|
<li>
|
||||||
|
<strong>2</strong> if there was an error specified on the command line such as not
|
||||||
providing an valid argument.</li>
|
providing an valid argument.</li>
|
||||||
<li><strong>3</strong> if there was one or more Apprise Service URLs successfully
|
<li>
|
||||||
|
<strong>3</strong> if there was one or more Apprise Service URLs successfully
|
||||||
loaded but none could be notified due to user filtering (via tags).</li>
|
loaded but none could be notified due to user filtering (via tags).</li>
|
||||||
</ul>
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
<h2 id="SERVICE-URLS">SERVICE URLS</h2>
|
<h2 id="SERVICE-URLS">SERVICE URLS</h2>
|
||||||
|
|
||||||
<p>There are to many service URL and combinations to list here. It's best to
|
<p>There are to many service URL and combinations to list here. It's best to
|
||||||
|
@ -233,7 +236,6 @@ notification service URLs and only notify the ones tagged as <em>devops</em>.</p
|
||||||
</code></pre>
|
</code></pre>
|
||||||
|
|
||||||
<h2 id="CUSTOM-PLUGIN-NOTIFICATIONS">CUSTOM PLUGIN/NOTIFICATIONS</h2>
|
<h2 id="CUSTOM-PLUGIN-NOTIFICATIONS">CUSTOM PLUGIN/NOTIFICATIONS</h2>
|
||||||
|
|
||||||
<p>Apprise can additionally allow you to define your own custom <strong>schema://</strong>
|
<p>Apprise can additionally allow you to define your own custom <strong>schema://</strong>
|
||||||
entries that you can trigger on and call services you've defined.</p>
|
entries that you can trigger on and call services you've defined.</p>
|
||||||
|
|
||||||
|
@ -254,7 +256,7 @@ it:
|
||||||
@notify(on="foobar", name="My Custom Notification")
|
@notify(on="foobar", name="My Custom Notification")
|
||||||
def my_wrapper(body, title, notify_type, *args, **kwargs):
|
def my_wrapper(body, title, notify_type, *args, **kwargs):
|
||||||
|
|
||||||
<define your custom code here>
|
<define your custom code here>
|
||||||
|
|
||||||
# Returning True/False is a way to relay your status back to Apprise.
|
# Returning True/False is a way to relay your status back to Apprise.
|
||||||
# Returning nothing (None by default) is always interpreted as a Success
|
# Returning nothing (None by default) is always interpreted as a Success
|
||||||
|
@ -316,12 +318,11 @@ configuration that you want and only specifically notify a subset of them:</p>
|
||||||
|
|
||||||
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
||||||
|
|
||||||
<p>Apprise is Copyright (C) 2024 Chris Caron <a href="mailto:lead2gold@gmail.com" data-bare-link="true">lead2gold@gmail.com</a></p>
|
<p>Apprise is Copyright (C) 2024 Chris Caron <a href="mailto:lead2gold@gmail.com" data-bare-link="true">lead2gold@gmail.com</a></p>
|
||||||
|
|
||||||
|
|
||||||
<ol class='man-decor man-foot man foot'>
|
<ol class='man-decor man-foot man foot'>
|
||||||
<li class='tl'>Chris Caron <lead2gold@gmail.com></li>
|
<li class='tl'>Chris Caron <lead2gold@gmail.com></li>
|
||||||
<li class='tc'>March 2024</li>
|
<li class='tc'>July 2024</li>
|
||||||
<li class='tr'>apprise(1)</li>
|
<li class='tr'>apprise(1)</li>
|
||||||
</ol>
|
</ol>
|
||||||
|
|
||||||
|
|
|
@ -55,7 +55,7 @@ Gateway, Twilio, Twitter, Twist, VictorOps, Voipms, Vonage, WeCom Bot,
|
||||||
WhatsApp, Webex Teams, Workflows, XBMC}
|
WhatsApp, Webex Teams, Workflows, XBMC}
|
||||||
|
|
||||||
Name: python-%{pypi_name}
|
Name: python-%{pypi_name}
|
||||||
Version: 1.8.0
|
Version: 1.8.1
|
||||||
Release: 1%{?dist}
|
Release: 1%{?dist}
|
||||||
Summary: A simple wrapper to many popular notification services used today
|
Summary: A simple wrapper to many popular notification services used today
|
||||||
License: BSD
|
License: BSD
|
||||||
|
@ -150,6 +150,15 @@ LANG=C.UTF-8 PYTHONPATH=%{buildroot}%{python3_sitelib} py.test-%{python3_version
|
||||||
%{python3_sitelib}/%{pypi_name}/cli.*
|
%{python3_sitelib}/%{pypi_name}/cli.*
|
||||||
|
|
||||||
%changelog
|
%changelog
|
||||||
|
* Thu Jul 25 2024 Chris Caron <lead2gold@gmail.com> - 1.8.1
|
||||||
|
- Updated to v1.8.1
|
||||||
|
|
||||||
|
* Fri Jul 19 2024 Fedora Release Engineering <releng@fedoraproject.org> - 1.8.0-3
|
||||||
|
- Rebuilt for https://fedoraproject.org/wiki/Fedora_41_Mass_Rebuild
|
||||||
|
|
||||||
|
* Fri Jun 07 2024 Python Maint <python-maint@redhat.com> - 1.8.0-2
|
||||||
|
- Rebuilt for Python 3.13
|
||||||
|
|
||||||
* Sat May 11 2024 Chris Caron <lead2gold@gmail.com> - 1.8.0
|
* Sat May 11 2024 Chris Caron <lead2gold@gmail.com> - 1.8.0
|
||||||
- Updated to v1.8.0
|
- Updated to v1.8.0
|
||||||
|
|
||||||
|
|
2
setup.py
2
setup.py
|
@ -62,7 +62,7 @@ else:
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name='apprise',
|
name='apprise',
|
||||||
version='1.8.0',
|
version='1.8.1',
|
||||||
description='Push Notifications that work with just about every platform!',
|
description='Push Notifications that work with just about every platform!',
|
||||||
license='BSD',
|
license='BSD',
|
||||||
long_description=open('README.md', encoding="utf-8").read(),
|
long_description=open('README.md', encoding="utf-8").read(),
|
||||||
|
|
Loading…
Reference in New Issue