From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH proxmox v2 35/63] notify: unify code paths for legacy-sendmail and regular notifications
Date: Wed, 18 Nov 2026 10:43:19 +0100 [thread overview]
Message-ID: <20261118094348.273646-36-l.wagner@proxmox.com> (raw)
In-Reply-To: <20261118094348.273646-1-l.wagner@proxmox.com>
In the future, we will introduce a per-product notification queue and
notification history. Given these changed semantics, it is much easier
if 'legacy-style', regular, and test notifications can be handled
through the same code paths.
This is achieved by introducing a 'recipient' field in the Notification
struct. It defaults to 'matcher', which just uses the configured
matchers to determine which targets shall receive the notification. The
'email' variant allows us to pass a subset of `SendmailConfig`; when
sending there will be an implicitly created sendmail target that is the
sole notified endpoint for this notification. Finally, there is also a
'target' mode, which allows us to deliver a notification straight to a
single configured target, which will be useful to unify the code paths
for test notifications.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
proxmox-notify/src/notification.rs | 40 +++++++++++++
proxmox-notify/src/send.rs | 93 ++++++++++++++++++++++--------
2 files changed, 108 insertions(+), 25 deletions(-)
diff --git a/proxmox-notify/src/notification.rs b/proxmox-notify/src/notification.rs
index 06b6e67e7..b3b93b545 100644
--- a/proxmox-notify/src/notification.rs
+++ b/proxmox-notify/src/notification.rs
@@ -84,6 +84,36 @@ pub struct Metadata {
pub(crate) additional_fields: HashMap<String, String>,
}
+#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "kebab-case")]
+/// Determine how the notification shall be sent.
+pub enum Recipient {
+ /// Use matchers to determine which targets shall be notified.
+ ///
+ /// This is the default mode of operation, use this unless you have a good
+ /// reason not to.
+ #[default]
+ Matcher,
+ /// Deliver notification directly to a target, identified by its ID.
+ ///
+ /// This is useful for test notifications.
+ Target(String),
+ /// Deliver notification to an ephemeral sendmail target with given list of recipients.
+ ///
+ /// This is mainly for handling the legacy-sendmail mode in PVE and PBS.
+ Email(EmailRecipient),
+}
+
+#[derive(Default, Debug, Clone, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "kebab-case")]
+/// Parameters for [`Recipient::Email`]-based recipients.
+pub struct EmailRecipient {
+ /// List of email addresses to send mails to.
+ pub mailto: Vec<String>,
+ /// Email author
+ pub author: Option<String>,
+}
+
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "kebab-case")]
/// Notification which can be sent
@@ -94,6 +124,9 @@ pub struct Notification {
pub(crate) metadata: Metadata,
/// Unique ID
pub(crate) id: Uuid,
+ #[serde(default)]
+ /// The recipient of the notification.
+ pub(crate) recipient: Recipient,
}
impl Notification {
@@ -114,6 +147,7 @@ impl Notification {
data: template_data,
},
id: Uuid::generate(),
+ recipient: Recipient::Matcher,
}
}
@@ -130,6 +164,7 @@ impl Notification {
timestamp: proxmox_time::epoch_i64(),
},
id: Uuid::generate(),
+ recipient: Recipient::Matcher,
})
}
@@ -157,6 +192,11 @@ impl Notification {
pub fn fields_mut(&mut self) -> &mut HashMap<String, String> {
&mut self.metadata.additional_fields
}
+
+ /// Return the recipient of the notification.
+ pub fn recipient(&self) -> &Recipient {
+ &self.recipient
+ }
}
#[cfg(test)]
diff --git a/proxmox-notify/src/send.rs b/proxmox-notify/src/send.rs
index 210a42599..f05661367 100644
--- a/proxmox-notify/src/send.rs
+++ b/proxmox-notify/src/send.rs
@@ -5,14 +5,16 @@ use proxmox_uuid::Uuid;
use serde_json::json;
use tracing::{error, info};
-use crate::api_types::MatcherConfig;
+use crate::api_types::{MatcherConfig, SendmailConfig};
use crate::config::{ConfigEntity, PrivateConfigEntity};
use crate::endpoints::Endpoint;
use crate::endpoints::gotify::GotifyEndpoint;
use crate::endpoints::sendmail::SendmailEndpoint;
use crate::endpoints::smtp::SmtpEndpoint;
use crate::endpoints::webhook::WebhookEndpoint;
-use crate::{Config, Content, Context, Error, Metadata, Notification, Severity};
+use crate::{
+ Config, Content, Context, EmailRecipient, Error, Metadata, Notification, Recipient, Severity,
+};
/// Send a notification to a given target.
///
@@ -143,30 +145,70 @@ impl Bus {
///
/// Any errors will not be returned but only logged.
pub fn send(&self, context: &Context, notification: &Notification) {
- let targets = self.check_matches(notification);
-
- for target in targets {
- if let Some(endpoint) = self.endpoints.get(target) {
- let name = endpoint.name();
-
- if endpoint.disabled() {
- // Skip this target if it is disabled
- info!("skipping disabled target '{name}'");
- continue;
- }
-
- match endpoint.send(context, notification) {
- Ok(_) => {
- info!("notified via target `{name}`");
- }
- Err(e) => {
- // Only log on errors, do not propagate fail to the caller.
- error!("could not notify via target `{name}`: {e}");
- }
- }
- } else {
- error!("could not notify via target '{target}', it does not exist");
+ match notification.recipient() {
+ Recipient::Email(params) => self.send_to_email(context, notification, params),
+ Recipient::Target(target) => {
+ self.send_to_target(context, notification, target);
}
+ Recipient::Matcher => {
+ let targets = self.check_matches(notification);
+
+ for target in targets {
+ self.send_to_target(context, notification, target);
+ }
+ }
+ }
+ }
+
+ fn send_to_email(
+ &self,
+ context: &Context,
+ notification: &Notification,
+ email_recipient: &EmailRecipient,
+ ) {
+ let recipient_list = email_recipient.mailto.join(", ");
+
+ let endpoint = SendmailEndpoint {
+ config: SendmailConfig {
+ name: "legacy-sendmail".into(),
+ mailto: email_recipient.mailto.clone(),
+ author: email_recipient.author.clone(),
+ ..Default::default()
+ },
+ };
+
+ match endpoint.send(context, notification) {
+ Ok(_) => {
+ info!("notified via `{recipient_list}`");
+ }
+ Err(e) => {
+ // Only log on errors, do not propagate fail to the caller.
+ error!("could not notify via `{recipient_list}`: {e}");
+ }
+ }
+ }
+
+ fn send_to_target(&self, context: &Context, notification: &Notification, target: &str) {
+ if let Some(endpoint) = self.endpoints.get(target) {
+ let name = endpoint.name();
+
+ if endpoint.disabled() {
+ // Skip this target if it is disabled
+ info!("skipping disabled target '{name}'");
+ return;
+ }
+
+ match endpoint.send(context, notification) {
+ Ok(_) => {
+ info!("notified via target `{name}`");
+ }
+ Err(e) => {
+ // Only log on errors, do not propagate fail to the caller.
+ error!("could not notify via target `{name}`: {e}");
+ }
+ }
+ } else {
+ error!("could not notify via target '{target}', it does not exist");
}
}
@@ -187,6 +229,7 @@ impl Bus {
data: json!({ "target": target }),
},
id: Uuid::generate(),
+ recipient: Recipient::Target(target.into()),
};
if let Some(endpoint) = self.endpoints.get(target) {
--
2.47.3
next prev parent reply other threads:[~2026-11-18 9:49 UTC|newest]
Thread overview: 66+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-18 9:42 [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 01/63] notify: disallow `unsafe` code Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 02/63] notify: refactor error type Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 03/63] notify: move `Endpoint` trait to endpoint module as pub(crate) Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 04/63] notify: use ConfigDigest instead of raw byte arrays Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 05/63] notify: remove static context and pass context as parameter Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 06/63] notify: matcher: drop unused field matcher verifiers Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 07/63] notify: introduce 'send-impl', 'api-impl' and 'api-types' features Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 08/63] notify: matcher: make matcher validation methods public Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 09/63] notify: matcher: stub CalendarMatcher::matches on wasm32 Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 10/63] notify: make SendmailEndpoint and SmtpEndpoint private types Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 11/63] notify: move `send`, `test_target` and `Bus` to new `send` module Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 12/63] notify: move Origin type to api_types module Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 13/63] notify: move Target " Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 14/63] notify: move Config to config module Lukas Wagner
2026-11-18 9:42 ` [PATCH proxmox v2 15/63] notify: move Notification and sub-types to `notification` module Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 16/63] notify: move schema module to api_types Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 17/63] notify: move check_matches from api_types::matcher to send::Bus Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 18/63] notify: move TemplateSource to context module Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 19/63] notify: config: cleanup helper names and visibility Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 20/63] notify: config: rename section config parser/writer methods Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 21/63] notify: config: pass builtins explicitly when parsing section config Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 22/63] notify: implement PartialEq for all Config types Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 23/63] notify: use typed SectionConfigData Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 24/63] notify: api: api types: rename Deleteable* -> Deletable* Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 25/63] notify: context: parse builtin config only once Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 26/63] notify: context: parse proxy config in trait impl, not at the callsite Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 27/63] notify: gate sub-modules with the appropriate feature flags Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 28/63] notify: fold mail-forwarder feature into send-impl Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 29/63] notify: forwarded mails: don't hardcode severity and metadata fields Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 30/63] notify: don't pass uid when instantiating forwarded mail notifications Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 31/63] notify: derive PartialEq for Notification type Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 32/63] notify: add getters for severity and fields on " Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 33/63] notify: add test suite for " Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 34/63] notify: serialize raw, forwarded mail content as base64 Lukas Wagner
2026-11-18 9:43 ` Lukas Wagner [this message]
2026-11-18 9:43 ` [PATCH proxmox v2 36/63] notify: add backwards-compat note to Notification type Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 37/63] notify: remove 'test_target' API Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 38/63] notify: replace notification instantiation with builder pattern Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 39/63] notify: add send receipts Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 40/63] notify: make sure that template name matches SAFE_ID_REGEX Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 41/63] notify: implement notification queue submitter Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 42/63] notify: context: add read_config Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 43/63] notify: queue: add queue consumer Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox v2 44/63] notify: queue: add worker task Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-backup v2 45/63] notifications: don't ignore verification errors in legacy-sendmail mode Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-backup v2 46/63] notifications: adapt to proxmox-notify API changes Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-backup v2 47/63] api: notification: send test notification via proxmox_notify::send Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-backup v2 48/63] notifications: send all notifications via proxmox-notify's queue Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-perl-rs v2 49/63] pve: notify: adapt to changes in the public API of proxmox-notify Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-perl-rs v2 50/63] pve: notify: add `PVE::RS::Notify::enqueue` method Lukas Wagner
2026-11-18 9:43 ` [PATCH pve-cluster v2 51/63] notify: send notifications via notification queue Lukas Wagner
2026-11-18 9:43 ` [PATCH manager v2 52/63] vzdump: send legacy-sendmail notifications via simplified API Lukas Wagner
2026-11-18 9:43 ` [PATCH manager v2 53/63] debian: create notification queue directory via tmpfiles Lukas Wagner
2026-11-18 9:43 ` [PATCH manager v2 54/63] debian: add 'pve-notify-worker' as dependecy Lukas Wagner
2026-11-18 9:43 ` [PATCH manager v2 55/63] api: services: add 'pve-notify-worker' as known service Lukas Wagner
2026-11-18 9:43 ` [PATCH manager v2 56/63] services: request pve-notify-worker.service via Wants Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-mail-forward v2 57/63] forward mails via notification queue Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-mail-forward v2 58/63] use return code to signal permanent or temporary failure Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-mail-forward v2 59/63] limit size of mail read from stdin Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-mail-forward v2 60/63] cargo: move mail forwarder into a workspace member crate Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-mail-forward v2 61/63] add crate for code shared between the mail-forwarder and the worker Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-mail-forward v2 62/63] add pve-notify-worker crate and package Lukas Wagner
2026-11-18 9:43 ` [PATCH proxmox-mail-forward v2 63/63] debian: add versioned break for pve-manager and proxmox-backup-server Lukas Wagner
2026-11-18 21:44 ` [PATCH many v2 00/63] notify: maintenance, PDM preparations, queue + worker Thomas Lamprecht
2026-11-19 10:45 ` Lukas Wagner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20261118094348.273646-36-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox