From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v5 39/44] proxmox-backup-manager: add CLI for SMTP endpoints
Date: Tue, 23 Apr 2024 13:52:25 +0200 [thread overview]
Message-ID: <20240423115230.170113-40-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240423115230.170113-1-l.wagner@proxmox.com>
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
Tested-by: Gabriel Goller <g.goller@proxmox.com>
Reviewed-by: Gabriel Goller <g.goller@proxmox.com>
Tested-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
.../notifications/mod.rs | 4 +-
.../notifications/smtp.rs | 96 +++++++++++++++++++
2 files changed, 99 insertions(+), 1 deletion(-)
create mode 100644 src/bin/proxmox_backup_manager/notifications/smtp.rs
diff --git a/src/bin/proxmox_backup_manager/notifications/mod.rs b/src/bin/proxmox_backup_manager/notifications/mod.rs
index 19a9dd0d..678f9c54 100644
--- a/src/bin/proxmox_backup_manager/notifications/mod.rs
+++ b/src/bin/proxmox_backup_manager/notifications/mod.rs
@@ -3,12 +3,14 @@ use proxmox_router::cli::{CliCommandMap, CommandLineInterface};
mod gotify;
mod matchers;
mod sendmail;
+mod smtp;
mod targets;
pub fn notification_commands() -> CommandLineInterface {
let endpoint_def = CliCommandMap::new()
.insert("gotify", gotify::commands())
- .insert("sendmail", sendmail::commands());
+ .insert("sendmail", sendmail::commands())
+ .insert("smtp", smtp::commands());
let cmd_def = CliCommandMap::new()
.insert("endpoint", endpoint_def)
diff --git a/src/bin/proxmox_backup_manager/notifications/smtp.rs b/src/bin/proxmox_backup_manager/notifications/smtp.rs
new file mode 100644
index 00000000..3a2b15ef
--- /dev/null
+++ b/src/bin/proxmox_backup_manager/notifications/smtp.rs
@@ -0,0 +1,96 @@
+use anyhow::Error;
+use proxmox_notify::schema::ENTITY_NAME_SCHEMA;
+use serde_json::Value;
+
+use proxmox_router::{cli::*, ApiHandler, RpcEnvironment};
+use proxmox_schema::api;
+
+use proxmox_backup::api2;
+
+#[api(
+ input: {
+ properties: {
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ }
+)]
+/// List all endpoints.
+fn list_endpoints(param: Value, rpcenv: &mut dyn RpcEnvironment) -> Result<Value, Error> {
+ let output_format = get_output_format(¶m);
+
+ let info = &api2::config::notifications::smtp::API_METHOD_LIST_ENDPOINTS;
+ let mut data = match info.handler {
+ ApiHandler::Sync(handler) => (handler)(param, info, rpcenv)?,
+ _ => unreachable!(),
+ };
+
+ let options = default_table_format_options()
+ .column(ColumnConfig::new("disable"))
+ .column(ColumnConfig::new("name"))
+ .column(ColumnConfig::new("server"))
+ .column(ColumnConfig::new("from-address"))
+ .column(ColumnConfig::new("mailto"))
+ .column(ColumnConfig::new("mailto-user"))
+ .column(ColumnConfig::new("comment"));
+
+ format_and_print_result_full(&mut data, &info.returns, &output_format, &options);
+
+ Ok(Value::Null)
+}
+
+#[api(
+ input: {
+ properties: {
+ name: {
+ schema: ENTITY_NAME_SCHEMA,
+ },
+ "output-format": {
+ schema: OUTPUT_FORMAT,
+ optional: true,
+ },
+ }
+ }
+)]
+/// Show a single endpoint.
+fn show_endpoint(param: Value, rpcenv: &mut dyn RpcEnvironment) -> Result<Value, Error> {
+ let output_format = get_output_format(¶m);
+
+ let info = &api2::config::notifications::smtp::API_METHOD_GET_ENDPOINT;
+ let mut data = match info.handler {
+ ApiHandler::Sync(handler) => (handler)(param, info, rpcenv)?,
+ _ => unreachable!(),
+ };
+
+ let options = default_table_format_options();
+ format_and_print_result_full(&mut data, &info.returns, &output_format, &options);
+
+ Ok(Value::Null)
+}
+
+pub fn commands() -> CommandLineInterface {
+ let cmd_def = CliCommandMap::new()
+ .insert("list", CliCommand::new(&API_METHOD_LIST_ENDPOINTS))
+ .insert(
+ "show",
+ CliCommand::new(&API_METHOD_SHOW_ENDPOINT).arg_param(&["name"]),
+ )
+ .insert(
+ "create",
+ CliCommand::new(&api2::config::notifications::smtp::API_METHOD_ADD_ENDPOINT)
+ .arg_param(&["name"]),
+ )
+ .insert(
+ "update",
+ CliCommand::new(&api2::config::notifications::smtp::API_METHOD_UPDATE_ENDPOINT)
+ .arg_param(&["name"]),
+ )
+ .insert(
+ "delete",
+ CliCommand::new(&api2::config::notifications::smtp::API_METHOD_DELETE_ENDPOINT)
+ .arg_param(&["name"]),
+ );
+ cmd_def.into()
+}
--
2.39.2
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next prev parent reply other threads:[~2024-04-23 11:54 UTC|newest]
Thread overview: 47+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-23 11:51 [pbs-devel] [PATCH many v5 00/44] integrate notification system Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 01/44] notify: expose `config` module Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 02/44] notify: use std::sync::OnceCell instead of lazy_static! Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 03/44] notify: pbs-context: exclude successful prunes in default matcher Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 04/44] notify: endpoints: matcher: improve descriptions for API types Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox v5 05/44] notify: add getter for notification timestamp Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH widget-toolkit v5 06/44] sendmail: smtp: allow to overide default mail author Lukas Wagner
2024-04-23 17:35 ` [pbs-devel] applied: " Thomas Lamprecht
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 07/44] pbs-config: add module for loading notification config Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 08/44] server: rename email_notifications module to notifications Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 09/44] notifications: allow sending notifications via proxmox_notify Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 10/44] buildsys: install templates for test notifications Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 11/44] pbs-config: acl: add /system/notifications as known ACL path Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 12/44] api: add endpoints for querying/testing notification targets Lukas Wagner
2024-04-23 11:51 ` [pbs-devel] [PATCH proxmox-backup v5 13/44] api: add endpoints for notification matchers Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 14/44] api: add endpoints for sendmail targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 15/44] api: add endpoints for smtp targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 16/44] api: add endpoints for gotify targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 17/44] api: add endpoints for querying known notification values/fields Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 18/44] api-types: api: datatore: add notification-mode parameter Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 19/44] api-types: api: tape: " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 20/44] server: notifications: send GC notifications via notification system Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 21/44] server: notifications: send prune " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 22/44] server: notifications: send verify " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 23/44] server: notifications: send sync " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 24/44] server: notifications: send update " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 25/44] server: notifications: send acme " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 26/44] server: notifications: send tape " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 27/44] ui: add notification config panel Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 28/44] ui: tape backup job: add selector for notification-mode Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 29/44] ui: tape backup: add selector for 'notification-mode' Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 30/44] ui: tape restore: add 'notification-mode' parameter Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 31/44] ui: datastore options: " Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 32/44] ui: utils: add overrides for known notification metadata fields/values Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 33/44] ui: datastore edit: make new stores use notification system by default Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 34/44] ui: permissions paths: add /system/notifications to combobox Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 35/44] proxmox-backup-manager: add CLI for notification targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 36/44] proxmox-backup-manager: add CLI for notification matchers Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 37/44] proxmox-backup-manager: add CLI for gotify endpoints Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 38/44] proxmox-backup-manager: add CLI for sendmail endpoints Lukas Wagner
2024-04-23 11:52 ` Lukas Wagner [this message]
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 40/44] docgen: generate synopsis for notifications{-priv, }.cfg Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 41/44] docs: add documentation for notification system Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 42/44] ui: util: override default mail author for sendmail/smtp targets Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 43/44] ui: notifications: pull in UX improvements for match rules creation Lukas Wagner
2024-04-23 11:52 ` [pbs-devel] [PATCH proxmox-backup v5 44/44] api: notification: also list datastores if user has only Backup privs Lukas Wagner
2024-04-23 22:23 ` [pbs-devel] applied-series: [PATCH many v5 00/44] integrate notification system Thomas Lamprecht
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=20240423115230.170113-40-l.wagner@proxmox.com \
--to=l.wagner@proxmox.com \
--cc=pbs-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