Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Server Configuration
Administrator can configure port 25 or port 587 for inbound SMTP communications over STARTTLS.
Listing SMTP Server Configuration
The request can be used to fetch the SMTP server side configuration present currently on the system.
|
The following is the response from the above *GET* request and the actual response will depend upon the current SMTP server configuration.
|
|
JSON Example
|
The following is the response from the above *GET* request and the actual response will depend upon the current SMTP server configuration:
|
|
Updating SMTP Server Configuration
The following is an example of the PUT request that update the configuration of SMTP Server.
|
<SmtpServerConfiguration>
<Port>25</Port>
<domainName>ucbu-aricent-vm234.cisco.com</domainName>
<maxNumberConnections>20</maxNumberConnections>
<smtpClientThreads>2</smtpClientThreads>
<maxMessageSizeKb>10000</maxMessageSizeKb>
<maxNumberMessagesSession>10</maxNumberMessagesSession>
<maxNumberRecipients>15000</maxNumberRecipients>
<retryDeliveryTimeoutMin>240</retryDeliveryTimeoutMin>
<allowConnectionsFromUntrustedIpAddresses>true</allowConnectionsFromUntrustedIpAddresses>
<requireAuthenticationFromUntrustedIpAddresses>true</requireAuthenticationFromUntrustedIpAddresses>
<requireTlsFromUntrustedIpAddresses>1</requireTlsFromUntrustedIpAddresses>
</SmtpServerConfiguration>
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
Response Code: 200
JSON Example
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Explaination of Data Fields
The following table explain the data fields:
Parameter | Data Type | Operations | Comments |
---|---|---|---|
Port | Integer | Read/Write | Specifies the port that Unity Connection uses to support secure/non-secure SMTP client communication. Possible values:
|
DomainName | String | Read/Write | Specifies the domain name that Unity Connection uses to route messages between digitally networked Unity Connection servers and to construct the SMTP address of the sender on outgoing SMTP messages. |
MaxNumberConnections | Integer | Read/Write |
Specifies the maximum number of SMTP clients that can be connected to the Unity Connection SMTP server at one time for sending messages. Possible values can be between 0 - 50. Default setting: 20 Unity Connections. |
SmtpClientThreads | Integer | Read/Write |
Specifies the maximum number of outgoing connections that the Unity Connection SMTP server can have open with other SMTP servers at one time. Possible values can be between 0 - 10. Default setting: 2 connections. |
MaxMessageSizeKb | Integer | Read/Write |
Specifies the maximum size of message that clients can send to Unity Connection using SMTP. Possible values can be between 0 - 50000 Kilobytes. Default setting: 10,000 kilobytes (approximately 10 megabytes). |
MaxNumberMessagesSession | Integer | Read/Write |
Specifies the maximum number of messages that a client can send to Unity Connection in a single SMTP session. Possible values can be between 0 - 100. Default setting: 10 messages. |
MaxNumberRecipients | Integer | Read/Write |
Specifies the maximum number of recipients allowed for a single message that is sent by a client to Unity Connection using SMTP. Possible values can be between 0 - 50000 Default setting: 15,000 recipients. |
RetryDeliveryTimeoutMin | Integer | Read/Write |
Specifies the time interval in minutes to have Unity Connection periodically retries the delivery of SMTP messages that have failed because of issues that may be temporary (for example, the remote SMTP server is not responding). If the timeout has passed without success, Unity Connection sends a non-delivery receipt to the sender. Default setting: 0 minutes (Unity Connection immediately sends a non-delivery receipt to the sender and does not retry delivery of failed SMTP messages). |
AllowConnectionsFromUntrustedIpAddresses | Boolean | Read/Write |
A flag indicating whether the Unity Connection enable or disable the SMTP connections from clients or servers whose IP addresses do not match any address pattern that is configured on the IP Address Access List. Possible values:
Default setting: false |
RequireAuthenticationFromUntrustedIpAddresses | Boolean | Read/Write |
A flag indicating whether the Unity Connection requires authentication for SMTP connections from clients or servers whose IP addresses do not match any address pattern that is configured on the IP Address Access List. Possible values:
This option is unavailable when the Allow Connections from Untrusted IP Addresses field is disabled. |
RequireTlsFromUntrustedIpAddresses | Integer | Read/Write |
Specifies how Unity Connection handles Transport Layer Security (TLS) with a client or server that attempts to connect from an IP address that does not match any address pattern configured on the IP Address Access List. Possible values:
This option is unavailable when the Allow Connections from Untrusted IP Addresses field is disabled. |