2022-09-23 15:07:30 +02:00
Send notifications via e-mail
=============================
2024-03-06 14:30:18 +01:00
[](https://github.com/eworm-de/routeros-scripts/stargazers)
[](https://github.com/eworm-de/routeros-scripts/network)
[](https://github.com/eworm-de/routeros-scripts/watchers)
[](https://mikrotik.com/download/changelogs/)
[](https://t.me/routeros_scripts)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=A4ZXBD6YS2W8J)
2023-01-10 14:45:27 +01:00
[⬅️ Go back to main README ](../../README.md )
2022-09-23 15:07:30 +02:00
> ℹ ️ ️
> 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 21:48:29 +01:00
Also make sure the device has correct time configured, best is to set up
the ntp client.
2022-09-23 15:07:30 +02:00
Then edit `global-config-overlay` , add `EmailGeneralTo` with a valid
recipient address. Finally reload the configuration.
2023-06-07 14:15:55 +02:00
> ℹ ️
> [`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 15:07:30 +02: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 09:51:23 +02:00
But of course you can use the function to send notifications directly. Give
it a try:
2022-09-23 15:07:30 +02:00
2023-11-08 17:31:14 +01:00
$SendEMail "Subject..." "Body...";
2022-09-23 15:07:30 +02:00
Alternatively this sends a notification with all available and configured
methods:
2023-11-08 17:31:14 +01:00
$SendNotification "Subject..." "Body...";
2022-09-23 15:07:30 +02:00
2023-05-22 09:51:23 +02: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 16:25:06 +02:00
In case there is a situation when the queue needs to be purged there is a
function available:
$PurgeEMailQueue;
2022-09-23 15:07:30 +02:00
See also
--------
* [Send notifications via Matrix ](notification-matrix.md )
2023-10-11 07:40:55 +02:00
* [Send notifications via Ntfy ](notification-ntfy.md )
2022-09-23 15:07:30 +02:00
* [Send notifications via Telegram ](notification-telegram.md )
---
2023-01-10 14:45:27 +01:00
[⬅️ Go back to main README ](../../README.md )
[⬆️ Go back to top ](#top )
