2022-09-23 13:07:30 +00:00
|
|
|
|
Send notifications via e-mail
|
|
|
|
|
|
=============================
|
|
|
|
|
|
|
2023-01-10 13:45:27 +00:00
|
|
|
|
[⬅️ Go back to main README](../../README.md)
|
2022-09-23 13:07:30 +00:00
|
|
|
|
|
|
|
|
|
|
> ℹ️️ **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).
|
2022-11-22 20:48:29 +00:00
|
|
|
|
Also make sure the device has correct time configured, best is to set up
|
|
|
|
|
|
the ntp client.
|
2022-09-23 13:07:30 +00:00
|
|
|
|
|
|
|
|
|
|
Then edit `global-config-overlay`, add `EmailGeneralTo` with a valid
|
|
|
|
|
|
recipient address. Finally reload the configuration.
|
|
|
|
|
|
|
2023-06-07 12:15:55 +00:00
|
|
|
|
> ℹ️ **Info**: Copy relevant configuration from
|
|
|
|
|
|
> [`global-config`](../../global-config.rsc) (the one without `-overlay`) to
|
|
|
|
|
|
> your local `global-config-overlay` and modify it to your specific needs.
|
|
|
|
|
|
|
2022-09-23 13:07:30 +00:00
|
|
|
|
### 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.
|
|
|
|
|
|
|
2023-05-22 07:51:23 +00:00
|
|
|
|
But of course you can use the function to send notifications directly. Give
|
|
|
|
|
|
it a try:
|
2022-09-23 13:07:30 +00:00
|
|
|
|
|
2023-11-08 16:31:14 +00:00
|
|
|
|
$SendEMail "Subject..." "Body...";
|
2022-09-23 13:07:30 +00:00
|
|
|
|
|
|
|
|
|
|
Alternatively this sends a notification with all available and configured
|
|
|
|
|
|
methods:
|
|
|
|
|
|
|
2023-11-08 16:31:14 +00:00
|
|
|
|
$SendNotification "Subject..." "Body...";
|
2022-09-23 13:07:30 +00:00
|
|
|
|
|
2023-05-22 07:51:23 +00:00
|
|
|
|
To use the functions in your own scripts you have to declare them first.
|
|
|
|
|
|
Place this before you call them:
|
|
|
|
|
|
|
|
|
|
|
|
:global SendEMail;
|
|
|
|
|
|
:global SendNotification;
|
|
|
|
|
|
|
2023-08-06 14:25:06 +00:00
|
|
|
|
In case there is a situation when the queue needs to be purged there is a
|
|
|
|
|
|
function available:
|
|
|
|
|
|
|
|
|
|
|
|
$PurgeEMailQueue;
|
|
|
|
|
|
|
2022-09-23 13:07:30 +00:00
|
|
|
|
See also
|
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
|
|
* [Send notifications via Matrix](notification-matrix.md)
|
2023-10-11 05:40:55 +00:00
|
|
|
|
* [Send notifications via Ntfy](notification-ntfy.md)
|
2022-09-23 13:07:30 +00:00
|
|
|
|
* [Send notifications via Telegram](notification-telegram.md)
|
|
|
|
|
|
|
|
|
|
|
|
---
|
2023-01-10 13:45:27 +00:00
|
|
|
|
[⬅️ Go back to main README](../../README.md)
|
|
|
|
|
|
[⬆️ Go back to top](#top)
|
