Get Started
Portal api methods
Help

POST api/2.0/settings/smtp This function requires authentication

Description

Save SMTP settings for current portal

Parameters
Name Description Type Example
smtpSettings
sent in body
SMTP settings data ASC.Api.Settings.Smtp.SmtpSettingsWrapper
Example
POST api/2.0/settings/smtp
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "smtpSettings": {
    "Host": null,
    "Port": null,
    "SenderAddress": null,
    "SenderDisplayName": null,
    "CredentialsUserName": null,
    "CredentialsUserPassword": null,
    "EnableSSL": false,
    "EnableAuth": false
  }
}
Returns

SmtpSettings data

Example Response

application/json

{
  "status": 0,
  "response": {
    "host": "mail.example.com",
    "port": 25,
    "senderAddress": "notify@example.com",
    "senderDisplayName": "Postman",
    "credentialsUserName": "notify@example.com",
    "credentialsUserPassword": "{password}",
    "enableSSL": false,
    "enableAuth": true
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <host>mail.example.com</host>
    <port>25</port>
    <senderAddress>notify@example.com</senderAddress>
    <senderDisplayName>Postman</senderDisplayName>
    <credentialsUserName>notify@example.com</credentialsUserName>
    <credentialsUserPassword>{password}</credentialsUserPassword>
    <enableSSL>false</enableSSL>
    <enableAuth>true</enableAuth>
  </response>
</result>