public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup v2 40/43] proxmox-backup-manager: add CLI for SMTP endpoints
Date: Wed, 17 Apr 2024 16:35:11 +0200	[thread overview]
Message-ID: <20240417143514.346233-41-l.wagner@proxmox.com> (raw)
In-Reply-To: <20240417143514.346233-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>
---
 .../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(&param);
+
+    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(&param);
+
+    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


  parent reply	other threads:[~2024-04-17 14:36 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-17 14:34 [pbs-devel] [PATCH many v2 00/43] integrate notification system Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 01/43] notify: expose `config` module Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 02/43] notify: use std::sync::OnceCell instead of lazy_static! Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 03/43] notify: pbs-context: exclude successful prunes in default matcher Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 04/43] notify: endpoints: matcher: improve descriptions for API types Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 05/43] notify: sys: move 'email' module from proxmox_sys to proxmox_notify Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox v2 06/43] notify: add getter for notification timestamp Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH widget-toolkit v2 07/43] sendmail: smtp: allow to overide default mail author Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 08/43] pbs-config: add module for loading notification config Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 09/43] server: rename email_notifications module to notifications Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 10/43] notifications: allow sending notifications via proxmox_notify Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 11/43] buildsys: install templates for test notifications Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 12/43] pbs-config: acl: add /system/notifications as known ACL path Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 13/43] api: add endpoints for querying/testing notification targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 14/43] api: add endpoints for notification matchers Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 15/43] api: add endpoints for sendmail targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 16/43] api: add endpoints for smtp targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 17/43] api: add endpoints for gotify targets Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 18/43] api: add endpoints for querying known notification values/fields Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 19/43] api-types: api: datatore: add notification-mode parameter Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 20/43] api-types: api: tape: " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 21/43] server: notifications: send GC notifications via notification system Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 22/43] server: notifications: send prune " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 23/43] server: notifications: send verify " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 24/43] server: notifications: send sync " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 25/43] server: notifications: send update " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 26/43] server: notifications: send acme " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 27/43] server: notifications: send tape " Lukas Wagner
2024-04-17 14:34 ` [pbs-devel] [PATCH proxmox-backup v2 28/43] ui: add notification config panel Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 29/43] ui: tape backup job: add selector for notification-mode Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 30/43] ui: tape backup: add selector for 'notification-mode' Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 31/43] ui: tape restore: add 'notification-mode' parameter Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 32/43] ui: datastore options: " Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 33/43] ui: utils: add overrides for known notification metadata fields/values Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 34/43] ui: datastore edit: make new stores use notification system by default Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 35/43] ui: permissions paths: add /system/notifications to combobox Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 36/43] proxmox-backup-manager: add CLI for notification targets Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 37/43] proxmox-backup-manager: add CLI for notification matchers Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 38/43] proxmox-backup-manager: add CLI for gotify endpoints Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 39/43] proxmox-backup-manager: add CLI for sendmail endpoints Lukas Wagner
2024-04-17 14:35 ` Lukas Wagner [this message]
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 41/43] docgen: generate synopsis for notifications{-priv, }.cfg Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 42/43] docs: add documentation for notification system Lukas Wagner
2024-04-17 14:35 ` [pbs-devel] [PATCH proxmox-backup v2 43/43] ui: util: override default mail author for sendmail/smtp targets 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=20240417143514.346233-41-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
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal