Get Started
Usage API
More information

GET api/2.0/settings/smtp/test This function requires authentication

Description

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

Parameters

This method doesn't have any parameters.

Example
GET api/2.0/settings/smtp/test
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

SMTP operation status

Example Response

application/json

{
  "status": 0,
  "response": {
    "completed": true,
    "id": "{some-random-guid}",
    "status": "",
    "error": "",
    "percents": 0,
    "source": ""
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <completed>true</completed>
    <id>{some-random-guid}</id>
    <status></status>
    <error></error>
    <percents>0</percents>
    <source></source>
  </response>
</result>