Skip to main content

Send Test Mail Req​

Select

SaaS
Customer Managed

To test Email settings

Request Body
  • SMTPServerName string required

    Possible values: non-empty

    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

    Possible values: non-empty

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

  • senderName string required

    Possible values: non-empty

    The sender name used for emails sent from the software.

  • encryptionAlgorithm string

    Possible values: [NONE, TLS, SSL]

    Default value: NONE

  • useAuthentication boolean

    The option to use authentication on the mail server. This is typically used in external or internet mail server configurations.

  • username string

    If username is specified, password field must also be specified. To use previously saved username and password, leave out username and password in payload.

  • password string

    If password is specified, username must also be specified. password should be a base 64 encoded string. To use previoulsy saved username and password, leave out username and password in payload.

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
Loading...