Skip to main content

Test the SMTP settings

GET /api/2.0/settings/smtp/test

Tests the SMTP settings for the current portal (send test message to the user email).

Returns​

SMTP operation status. A request that is not authenticated returns 401.

Completed​

type: boolean

Example: true

Id​

type: string

Example: "{some-random-guid}"

Status​

type: string

Example: ""

Error​

type: string

Example: ""

Percents​

type: integer

Example: 0

Source​

type: string

Example: ""

Response example​

{
  "Completed": true,
  "Id": "{some-random-guid}",
  "Status": "",
  "Error": "",
  "Percents": 0,
  "Source": ""
}