notifications: add documentation for system mail forwarding

Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
This commit is contained in:
Lukas Wagner 2023-11-14 13:59:57 +01:00 committed by Thomas Lamprecht
parent e39dfad987
commit 7b293b5d9a

View File

@ -281,6 +281,7 @@ Notification Events
| Cluster node fenced |`fencing` | `error` | `hostname` | Cluster node fenced |`fencing` | `error` | `hostname`
| Storage replication failed |`replication` | `error` | - | Storage replication failed |`replication` | `error` | -
| Backup finished |`vzdump` | `info` (`error` on failure) | `hostname` | Backup finished |`vzdump` | `info` (`error` on failure) | `hostname`
| Mail for root |`system-mail` | `unknown`| -
|=========================================================================== |===========================================================================
[width="100%",options="header"] [width="100%",options="header"]
@ -290,6 +291,21 @@ Notification Events
| `hostname` | Hostname, including domain (e.g. `pve1.example.com`) | `hostname` | Hostname, including domain (e.g. `pve1.example.com`)
|======================================================================= |=======================================================================
System Mail Forwarding
---------------------
Certain local system daemons, such as `smartd`, generate notification emails
that are initially directed to the local `root` user. {pve} will
feed these mails into the notification system as a notification of
type `system-mail` and with severity `unknown`.
When the forwarding process involves an email-based target
(like `sendmail` or `smtp`), the email is forwarded exactly as received, with all
original mail headers remaining intact. For all other targets,
the system tries to extract both a subject line and the main text body
from the email content. In instances where emails solely consist of HTML
content, they will be transformed into plain text format during this process.
Permissions Permissions
----------- -----------