Edit the system SMTP configuration

Edit online

Configure the email capability of the system.

Request

Edit online

Security

Edit online
Table 1. Roles capable of executing the Edit System SMTP Configuration API method
Any Super User System Admin Security Admin Operator
  superUser systemAdmin    

HTTP method

Edit online

POST /manager/api/{apiResponseType}/1.0/editSystemSmtpConfiguration.adm HTTP/1.1 Host:{manager.dsnet} enabled={true|false}&from={fromEmail}&host={mailHost}&secure={true|false}

Curl method

Edit online

curl -u {admin}:{password} -k ”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/editSystemSmtpConfiguration.adm“ -d ”enabled={true|false}&from={fromEmail}&host={mailHost}&secure={true|false}“

Parameters

Edit online
Table 2. Request parameters for Edit System SMTP Configuration (editSystemSmtpConfiguration) API method
Parameter Type Usage Default Description
enabled Boolean Optional  

Enables or disables SMTP.

  • If false, no other parameters are received and all previous values are lost.
  • If true, from and host are needed.
  • If not given, previous settings remain.
from String enabled=true  

From address to send for outgoing emails; must be a valid email address.
host String enabled=true  

Address of host SMTP server.
secure Boolean Optional  

Use SMTP over SSL.
usingCustomPort Boolean Optional false

Flag specifies whether to use a custom port.
port Int Optional 25 / 465 (SMTP / SMTPS)

Port that is used with SMTP server.
authenticated Boolean Optional false

SMTP server requires authentication.
username String authenticated=true  

User name to authenticate with SMTP server.
password String authenticated=true  

Password to authenticate with SMTP server.
testAddress String Optional  

Valid email address. Manager sends a daily email to this email address if given.