This operation updates the configuration for the email server.
Request
Syntax
Send the request using either XML or JSON:
-
XML
POST <webservice>/EmailServer HTTP/1.1 Host: <host name> Accept: application/xml Authtoken: <authentication token> Content-type: application/xml <update_email_server_template.xml>
-
JSON
POST <webservice>/EmailServer HTTP/1.1 Host: <host name> Accept: application/json Authtoken: <authentication token> Content-type: application/json <update_email_server_template.json>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
|
Content-type |
The media type contained in the request body. |
Request Body
Download the XML or JSON file required for this request: update_email_server_template.xml or update_email_server_template.json. The following table displays the parameters for the request body.
|
Parameter |
Description |
Element |
|---|---|---|
|
maxMailServerSize |
The email size limit in kilobytes for the configured mail server. Use the default value of 0 KB if there is no mail server size limit. Note: Log file bundles exceeding the designated maximum size are sent using multiple emails. |
App_SMTPInfo |
|
useAuthentication |
The option to use authentication on the mail server. This is typically used in external or internet mail server configurations. Valid values are:
|
App_SMTPInfo |
|
enableSSL |
The option to use Secure Socket Layers (SSL) for security authentication. Valid values are:
|
App_SMTPInfo |
|
smtpPort |
The port number that connects to the mail server. The default is 25. |
App_SMTPInfo |
|
smtpServer |
The name of the mail server that sends alerts, scheduled reports, log files, and additional information. |
App_SMTPInfo |
|
senderAddress |
The sender email address used for emails sent from the software. |
senderInfo |
|
senderName |
The sender name used for emails sent from the software. |
senderInfo |
|
password |
The password to use when the useAuthentication parameter is set to 1. |
userInfo |
|
userName |
The user name to use when the useAuthentication parameter is set to 1. |
duserInfo |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
errorCode |
The possible error codes. Valid values are:
|
App_GenericEntityResponse |
|
errorString |
The description of the error code. Not all error codes have an error string. |
App_GenericEntityResponse |
Examples
Sample Request
POST <webservice>/EmailServer HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<App_SetSMTPInfo>
<smtpInfo smtpServer="SMTP.mycompany.com" smtpPort="25" enableSSL="0" useAuthentication="1" maxMailServerSize="10240">
<senderInfo senderName="Software" senderAddress="Software@hostname.com" />
<userInfo userName="user001" password="samplepassword" />
</smtpInfo>
</App_SetSMTPInfo>
Sample Response
This is the response when the email server configuration is updated.
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericEntityResponse errorCode="0" errorString=""/>
This is the response when a user does not have the administrative management capability.
<App_GenericEntityResponse errorCode="1" errorString="You do not have sufficient privileges for this operation"/>
