routeros-scripts/doc/mod/notification-email.md
Christian Hesse 34ed387343 use arrows with emoji representation
We had...

  ◀ Go back to main README
  ▲ Go back to top

... and switch to...

  ⬅️ Go back to main README
  ⬆️ Go back to top
2023-01-11 12:28:31 +01:00

65 lines
1.8 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

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).
Also make sure the device has correct time configured, best is to set up
the ntp client.
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)