SMTP External Servers are used to specify connections to an SMTP server.
SMTP External Servers provide the information needed to connect to a SMTP Server. To use a secure connection method to the SMTP server, and user-name and password must also be provided.
The SMTP External Server component inherits from the External Server
The following components have a direct aggregation relation from SMTP External Servers:
The following components have a direct aggregation relation to SMTP External Servers:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | smtp-timeout |
| server-host-name | smtp-connection-properties |
| server-port | |
| smtp-security | |
| user-name | |
| password | |
| passphrase-provider |
| Description | A description for this External Server |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The host name of the smtp server. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | The port number where the smtp server listens for requests. |
| Default Value | 25 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 65535 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | This property specifies type of connection security to use when connecting to the outgoing mail server. There are a couple of different protocols that can be used when connecting to a SMTP based mail server. Set this property to match the security protocol of your mail server. |
| Default Value | none |
| Allowed Values | none - No connection security will be used to connect with the mail server. starttls - Use a TLS-protected connection after connecting to the mail server. ssl - Use SSL to connect to the mail server. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The name of the login account to use when connecting to the smtp server. Both username and password must be supplied if this attribute is set. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The login password for the specified user name. Both username and password must be supplied if this attribute is set. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The passphrase provider to use to obtain the login password for the specified user. |
| Default Value | None |
| Allowed Values | The DN of any Passphrase Provider. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
smtp-timeout (Advanced Property)
| Description | Specifies the maximum length of time that a connection or attempted connection to a SMTP server may take. A value of "0 seconds" indicates that no idle time limit is enforced. |
| Default Value | 2 minutes |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
smtp-connection-properties (Advanced Property)
| Description | Specifies the connection properties for the smtp server. The properties are specific to the SMTP server you are using. All types of values (literals, booleans, numbers, etc.) are interpreted as strings. These properties are based on the JavaMail API. |
| Default Value | None |
| Allowed Values | A 'key=value' property pair to use with the SMTP server connection. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured External Servers:
dsconfig list-external-servers
[--property {propertyName}] ...
To view the configuration for an existing External Server:
dsconfig get-external-server-prop
--server-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing External Server:
dsconfig set-external-server-prop
--server-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new SMTP External Server:
dsconfig create-external-server
--server-name {name}
--type smtp
--set server-host-name:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing External Server:
dsconfig delete-external-server
--server-name {name}