REST API - GET Email Server

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.

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

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

useAuthentication

The option to use authentication on the mail server. This is typically used in external or internet mail server configurations.

Valid values are:

• 0, to disable authentication

• 1, to enable authentication

App_SMTPInfo

enableSSL

The option to use Secure Socket Layers (SSL) for security authentication.

Valid values are:

• 0, to disable SSL

• 1, to enable SSL

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