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

Description

Saves the SMTP settings for the current portal.

Parameters
Name Description Type Example
Host
sent in body
Host string some text
Port
sent in body
Port number 1234
SenderAddress
sent in body
Sender address string some text
SenderDisplayName
sent in body
Sender display name string some text
CredentialsUserName
sent in body
Credentials username string some text
CredentialsUserPassword
sent in body
Credentials user password string some text
EnableSSL
sent in body
Enables SSL or not Bool value true
EnableAuth
sent in body
Enables authentication or not Bool value true
UseNtlm
sent in body
Specifies whether to use NTLM or not Bool value true
IsDefaultSettings
sent in body
Specifies if the current settings are default or not Bool value true
Example
POST api/2.0/smtpsettings/smtp
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "Host": "mail.example.com",
  "Port": "25",
  "SenderAddress": "notify@example.com",
  "SenderDisplayName": "Postman",
  "CredentialsUserName": "notify@example.com",
  "CredentialsUserPassword": "{password}",
  "EnableSSL": true,
  "EnableAuth": false,
  "UseNtlm": false,
  "IsDefaultSettings": false
}
Returns

SMTP settings

Example Response
{
  "status": 0,
  "response": {
    "Host": "mail.example.com",
    "Port": "25",
    "SenderAddress": "notify@example.com",
    "SenderDisplayName": "Postman",
    "CredentialsUserName": "notify@example.com",
    "CredentialsUserPassword": "{password}",
    "EnableSSL": true,
    "EnableAuth": false,
    "UseNtlm": false,
    "IsDefaultSettings": false
  }
}