feat: Add ability to configure and test SMTP via UI

2025-12-17 09:13:23 +03:00 · 2025-09-22 20:35:13 +02:00
parent 3a12bb7457
commit c6f4dcdb70
114 changed files with 2161 additions and 301 deletions
--- a/server/api/controllers/config/update.js
+++ b/server/api/controllers/config/update.js
@@ -0,0 +1,151 @@
+/*!
+ * Copyright (c) 2024 PLANKA Software GmbH
+ * Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
+ */
+
+/**
+ * @swagger
+ * /config:
+ *   patch:
+ *     summary: Update application configuration
+ *     description: Updates the application configuration. Requires admin privileges.
+ *     tags:
+ *       - Config
+ *     operationId: updateConfig
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             properties:
+ *               smtpHost:
+ *                 type: string
+ *                 maxLength: 256
+ *                 nullable: true
+ *                 description: Hostname or IP address of the SMTP server
+ *                 example: smtp.example.com
+ *               smtpHost:
+ *                 type: number
+ *                 minimum: 0
+ *                 maximum: 65535
+ *                 nullable: true
+ *                 description: Port number of the SMTP server
+ *                 example: 587
+ *               smtpName:
+ *                 type: string
+ *                 maxLength: 256
+ *                 nullable: true
+ *                 description: Client hostname used in the EHLO command for SMTP
+ *                 example: localhost
+ *               smtpSecure:
+ *                 type: boolean
+ *                 description: Whether to use a secure connection for SMTP
+ *                 example: false
+ *               smtpTlsRejectUnauthorized:
+ *                 type: boolean
+ *                 description: Whether to reject unauthorized or self-signed TLS certificates for SMTP connections
+ *                 example: true
+ *               smtpUser:
+ *                 type: string
+ *                 maxLength: 256
+ *                 nullable: true
+ *                 description: Username for authenticating with the SMTP server
+ *                 example: no-reply@example.com
+ *               smtpPassword:
+ *                 type: string
+ *                 maxLength: 256
+ *                 nullable: true
+ *                 description: Password for authenticating with the SMTP server
+ *                 example: SecurePassword123!
+ *               smtpFrom:
+ *                 type: string
+ *                 maxLength: 256
+ *                 nullable: true
+ *                 description: Default "from" used for outgoing SMTP emails
+ *                 example: no-reply@example.com
+ *     responses:
+ *       200:
+ *         description: Configuration updated successfully
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               required:
+ *                 - item
+ *               properties:
+ *                 item:
+ *                   $ref: '#/components/schemas/Config'
+ */
+
+module.exports = {
+  inputs: {
+    smtpHost: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 256,
+      allowNull: true,
+    },
+    smtpPort: {
+      type: 'number',
+      min: 0,
+      max: 65535,
+      allowNull: true,
+    },
+    smtpName: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 256,
+      allowNull: true,
+    },
+    smtpSecure: {
+      type: 'boolean',
+    },
+    smtpTlsRejectUnauthorized: {
+      type: 'boolean',
+    },
+    smtpUser: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 256,
+      allowNull: true,
+    },
+    smtpPassword: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 256,
+      allowNull: true,
+    },
+    smtpFrom: {
+      type: 'string',
+      isNotEmptyString: true,
+      maxLength: 256,
+      allowNull: true,
+    },
+  },
+
+  async fn(inputs) {
+    const { currentUser } = this.req;
+
+    const values = _.pick(inputs, [
+      'smtpHost',
+      'smtpPort',
+      'smtpName',
+      'smtpSecure',
+      'smtpTlsRejectUnauthorized',
+      'smtpUser',
+      'smtpPassword',
+      'smtpFrom',
+    ]);
+
+    const config = await sails.helpers.config.updateMain.with({
+      values,
+      actorUser: currentUser,
+      request: this.req,
+    });
+
+    return {
+      item: sails.helpers.config.presentOne(config),
+    };
+  },
+};