Test Mail Config

Test Mail Config

Send test mail using the specified mail config.

Request
URI
POST
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/configuration/notification/test-mail
COPY
Request Body
EmailNotification of type(s) application/json
Required

Show optional properties

{
    "smtpServer": "string"
}
{
    "enabled": false,
    "smtpServer": "string",
    "smtpPort": 0,
    "smtpUsername": "string",
    "smtpPassword": "string",
    "useTls": false,
    "useSsl": false,
    "useProxy": false,
    "senderAddress": "string",
    "emailSubjectTemplate": "string",
    "emailContentTemplate": "string",
    "receiverAddresses": [
        "string"
    ]
}
boolean
enabled
Optional

Enable or disable Email notifications.

string
smtpServer
Required

The host of the sender.

integer As int32 As int32
smtpPort
Optional

The port used for mails. Default: 25.

string
smtpUsername
Optional

Optional. The username to authenticate with the SMTP server. If not set, no authentication will be used.

string
smtpPassword
Optional

Optional. The password to authenticate with the SMTP server. If not set, no authentication will be used.

boolean
useTls
Optional

Define whether to use TLS or not.

boolean
useSsl
Optional

Define whether to use SSL or not.

boolean
useProxy
Optional

Enable to use the system-specified proxy for sending emails.

string
senderAddress
Optional

The email address to send notification emails with.

string
emailSubjectTemplate
Optional

An email subject to use for email notifications.

string
emailContentTemplate
Optional

The content to add to the email notifications' body.

array of string
receiverAddresses
Optional

The email addresses of receivers for notifications.

Responses
200

Test mail sent successfully.

Operation doesn't return any data structure

400

Invalid mail config spec

Operation doesn't return any data structure

401

Unauthorized access

Operation doesn't return any data structure

404

Config file does not exist.

Operation doesn't return any data structure

On This Page
Configuration Operations
GET
Get Automatic Task Config
GET
Get Notification Config
GET
Get Telemetry Config
GET
Get Vcp Lcm Config
POST
Test Mail Config
PATCH
Update Automatic Task Config
PATCH
Update Notification Config
PATCH
Update Telemetry Config
PATCH
Update Vcp Lcm Config