Test Email Settings

Test Email Settings

Tests that Email SMTP Settings are valid

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/smtp/test
COPY
Request Body

Email Settings and destination email address for Email Test call

TestEmailRequest of type(s) application/json
Required 
{
    "emailSettings": {
        "defaultSmtpServer": false,
        "defaultOrgEmail": false,
        "smtpServer": {
            "useAuthentication": false,
            "secureMode": "string",
            "url": {
                "host": "string",
                "port": 0,
                "ssl": false
            },
            "sslTrustStore": "string",
            "userName": "string",
            "password": "string",
            "description": "string",
            "name": "string"
        },
        "senderEmailAddress": "string",
        "defaultEmailSubjectPrefix": "string",
        "alertEmailToAllAdmins": false,
        "alertEmailTo": "string"
    },
    "destination": "string"
}
EmailSettings
emailSettings
Optional

Email related settings for a system

string
destination
Optional

destination

Authentication
This operation uses the following authentication methods.
Responses
204

OK

Operation doesn't return any data structure

On This Page
Email Settings Operations
POST
Test Email Settings