Configure Email Server

Configure SMTP server settings.

application/json

Request Body

• SMTPServerName string required

  The name of the mail server that sends alerts, scheduled reports, log files, and additional information.

• SMTPPort int32 required

  The port number that connects to the mail server.

• senderEmail string required

  The sender email address used for emails sent from the software.

• senderName string required

  The sender name used for emails sent from the software.

• encryptionAlgorithm string

  Possible values: [NONE, TLS, SSL]

  Default value: NONE

• username string

  This option is used when authentication on the mail server is required

• password string

  Password must be in base64 encoded format. Similar to username, if authentication on the mail server is required, this option is required.

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Bad Request

Unauthorized

Loading...