diff options
Diffstat (limited to 'doc/mod')
-rw-r--r-- | doc/mod/notification-email.md | 63 | ||||
-rw-r--r-- | doc/mod/notification-matrix.md | 1 | ||||
-rw-r--r-- | doc/mod/notification-telegram.md | 1 |
3 files changed, 65 insertions, 0 deletions
diff --git a/doc/mod/notification-email.md b/doc/mod/notification-email.md new file mode 100644 index 0000000..4e0ba04 --- /dev/null +++ b/doc/mod/notification-email.md @@ -0,0 +1,63 @@ +Send notifications via e-mail +============================= + +[◀ Go back to main README](../../README.md) + +> ℹ️️ **Info**: This module can not be used on its own but requires the base +> installation. See [main README](../../README.md) for details. + +Description +----------- + +This module adds support for sending notifications via e-mail. A queue is +used to make sure notifications are not lost on failure but sent later. + +Requirements and installation +----------------------------- + +Just install the module: + + $ScriptInstallUpdate mod/notification-email; + +Also you need a valid e-mail account with smtp login credentials. + +Configuration +------------- + +Set up your device's +[e-mail settings](https://wiki.mikrotik.com/wiki/Manual:Tools/email). + +Then edit `global-config-overlay`, add `EmailGeneralTo` with a valid +recipient address. Finally reload the configuration. + +### Sending to several recipients + +Sending notifications to several recipients is possible as well. Add +`EmailGeneralCc` on top, which can have a single mail address or a comma +separated list. + +Usage and invocation +-------------------- + +There's nothing special to do. Every script or function sending a notification +will now send it to your e-mail account. + +But of course you can send notifications directly or use a function in your +own scripts. Give it a try: + + $SendEMail "Subject..." "Body..." + +Alternatively this sends a notification with all available and configured +methods: + + $SendNotification "Subject..." "Body..." + +See also +-------- + +* [Send notifications via Matrix](notification-matrix.md) +* [Send notifications via Telegram](notification-telegram.md) + +--- +[◀ Go back to main README](../../README.md) +[▲ Go back to top](#top) diff --git a/doc/mod/notification-matrix.md b/doc/mod/notification-matrix.md index c5003e0..b1f520e 100644 --- a/doc/mod/notification-matrix.md +++ b/doc/mod/notification-matrix.md @@ -103,6 +103,7 @@ methods: See also -------- +* [Send notifications via e-mail](notification-email.md) * [Send notifications via Telegram](notification-telegram.md) --- diff --git a/doc/mod/notification-telegram.md b/doc/mod/notification-telegram.md index 3bb31a7..2b1abe9 100644 --- a/doc/mod/notification-telegram.md +++ b/doc/mod/notification-telegram.md @@ -66,6 +66,7 @@ methods: See also -------- +* [Send notifications via e-mail](notification-email.md) * [Send notifications via Matrix](notification-matrix.md) --- |