Mail Server API
Mail Server API allows the user to view mail server details and configure mail server parameters in Applications Manager. This API is designed to support GET and POST requests.
Syntax
GET Request
Whenever the request is sent by "GET" method, the data corresponding to the API will be listed.
https://[HOST]:[PORT]/AppManager/xml/MailServer?apikey=[apikey]
POST Request
When the request is sent by "POST" method, the corresponding data will be added/updated.
https://[HOST]:[PORT]/AppManager/xml/MailServer?apikey=[apikey]
Supported HTTP methods: GET, POST
Allowed roles: Administrator
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. |
Sample Request
https://apm-prod-server:8443/AppManager/xml/MailServer?apikey=aaaaaabbbbbbccccccddddddeeeeee
