Get Started
Usage API
More information

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

Description

Returns the SMTP test process status.

Parameters

This method doesn't have any parameters.

Example
GET api/2.0/settings/smtp/test/status
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 />
    <Error />
    <Percents>0</Percents>
    <Source />
  </response>
</result>