From 7b293b5d9a33b5d9c9c7fac6a1e53b4f6d6df9d2 Mon Sep 17 00:00:00 2001 From: Lukas Wagner Date: Tue, 14 Nov 2023 13:59:57 +0100 Subject: [PATCH] notifications: add documentation for system mail forwarding Signed-off-by: Lukas Wagner --- notifications.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/notifications.adoc b/notifications.adoc index e8ed51b..c7bdc5a 100644 --- a/notifications.adoc +++ b/notifications.adoc @@ -281,6 +281,7 @@ Notification Events | Cluster node fenced |`fencing` | `error` | `hostname` | Storage replication failed |`replication` | `error` | - | Backup finished |`vzdump` | `info` (`error` on failure) | `hostname` +| Mail for root |`system-mail` | `unknown`| - |=========================================================================== [width="100%",options="header"] @@ -290,6 +291,21 @@ Notification Events | `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 -----------