Mail Server Configuration APIs


Mail Server API allows the user to view mail server details and configure mail server parameters in Applications Manager. These APIs allow an admin user to configure the mail server to send e-mail to specified persons in the event of an alarm. This API is designed to support GET and POST requests.

GET Request

Whenever the request is sent by "GET" method, the data corresponding to the API will be listed.

Sample Request

http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey]

POST Request

When the request is sent by "POST" method, the corresponding data will be added/updated.

Sample Request

http://[host]:[port]/AppManager/xml/MailServer?apikey=[apikey]

Request Parameters

The parameters involved in the API request are described below:

For Primary Server:

Field Description
smtpServer The Server IP or host name of the host in which the SMTP server runs.
smtpPort The SMTP port number.
smtpEmail The email address available in that SMTP server.
smtpUserName User name for authentication
smtpPassword Password for authentication
prmTlsAuth Primary Tls Authentication. The value can be either true or false.
prmSslAuth Primary SSL Authentication. The value can be either true or false.

For Secondary Server:

Field Description
secSmtpServer The Server IP or host name of the host in which the SMTP server runs.
secSmtpPort The SMTP port number.
secSmtpEmail The email address available in that SMTP server.
secSmtpUserName Username for authentication.
secSmtpPassword Password for authentication.
secTlsAuth Secondary Tls Authentication. The value can be either true or false.
secSslAuth Secondary SSL Authentication. The value can be either true or false.

Example

http://app-windows:9091/AppManager/xml/MailServer?apikey=7b5fde68148fa2419bc2f1a1ab87e75

Syntax

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/MailServer?apikey=[ API Key ]&smtpPort=[ Port ]&prmTlsAuth=true&prmSslAuth=[ True/False ]&secSslAuth=[ True/False ]&fromAdminServer=[ True/False ]&smtpUserName=[ Username]&smtpPassword=[ Password ]&secTlsAuth=[ True/False ]&smtpServer=[ Server Name ]&secSmtpPort=[ Secondary Port ]&secSmtpEmail=[ Email Address ]&secSmtpUserName=[ user Name ]&smtpEmail=[ Email Address ]&secSmtpServer=[ Secondary Server Name ]&secSmtpPassword=[ Password ]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/MailServer?apikey=[ API Key ]&smtpPort=[ Port ]&prmTlsAuth=true&prmSslAuth=[ True/False ]&secSslAuth=[ True/False ]&fromAdminServer=[ True/False ]&smtpUserName=[ Username]&smtpPassword=[ Password ]&secTlsAuth=[ True/False ]&smtpServer=[ Server Name ]&secSmtpPort=[ Secondary Port ]&secSmtpEmail=[ Email Address ]&secSmtpUserName=[ user Name ]&smtpEmail=[ Email Address ]&secSmtpServer=[ Secondary Server Name ]&secSmtpPassword=[ Password ]

Example

http://app-windows:59090/AppManager/xml/MailServer?apikey=09eebdd6893db4d20e16b84dff6664f1&smtpPort=25&prmTlsAuth=true&prmSslAuth=true&secSslAuth=true&fromAdminServer=true&smtpUserName=primary&smtpPassword=f6JO6Wdbo&secTlsAuth=true&smtpServer=smtp&secSmtpPort=25&secSmtpEmail=JohnDoe@yahoo.com&secSmtpUserName=secondary&smtpEmail=JohnDoe@appmanager.com&secSmtpServer=smtp&secSmtpPassword=f6JO5sMs6n7