--- title: Mail Server description: Mail Servers are used to define how to connect and authenticate to an external mail server. component: pingds version: 8.1 page_id: pingds:configref:objects-mail-server canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-mail-server.html section_ids: dependencies: Dependencies mail_server_properties: Mail Server properties basic_properties: Basic properties auth-password: auth-password auth-username: auth-username enabled: enabled smtp-server: smtp-server trust-manager-provider: trust-manager-provider use-ssl: use-ssl use-start-tls: use-start-tls advanced_properties: Advanced properties smtp-property: smtp-property --- # Mail Server Mail Servers are used to define how to connect and authenticate to an external mail server. Mail servers (SMTP MTAs) may require that messages are submitted on particular network ports, over TLS, and using certain authentication credentials. ## Dependencies Mail Servers depend on the following objects: * [Trust Manager Provider](objects-trust-manager-provider.html) ## Mail Server properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | | [auth-password](#auth-password) [auth-username](#auth-username) [enabled](#enabled) [smtp-server](#smtp-server) [trust-manager-provider](#trust-manager-provider) [use-ssl](#use-ssl) [use-start-tls](#use-start-tls) | [smtp-property](#smtp-property) | ### Basic properties Use the `--advanced` option to access advanced properties. ### auth-password | | | | ----------------------- | ---------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the password for authenticating to the SMTP server. You must also set the auth-name. | | *Default value* | Do not authenticate to the remote SMTP server. | | *Allowed values* | A string. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### auth-username | | | | ----------------------- | ------------------------------------------------------------- | | *Synopsis* | Specifies the username for authenticating to the SMTP server. | | *Default value* | Do not authenticate to the remote SMTP server. | | *Allowed values* | A string. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### enabled | | | | ----------------------- | --------------------------------------------- | | *Synopsis* | Indicates whether the Mail Server is enabled. | | *Default value* | None | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### smtp-server | | | | ----------------------- | -------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the address (and optional port number) for a mail server that can be used to send email messages via SMTP. | | *Description* | It may be an IP address or resolvable hostname, optionally followed by a colon and a port number. | | *Default value* | None | | *Allowed values* | A hostname, optionally followed by a ":" followed by a port number. If not specified, port 587 is used. | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### trust-manager-provider | | | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the name of the trust manager that should be used when negotiating SSL connections with remote mail servers. | | *Default value* | By default, no trust manager is specified indicating that only certificates signed by the authorities associated with this JVM will be accepted. | | *Allowed values* | The name of an existing [trust-manager-provider](objects-trust-manager-provider.html).The referenced trust manager provider must be enabled when SSL or StartTLS is enabled. | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | NoneChanges to this property take effect immediately, but only impact subsequent SSL connection negotiations. | | *Advanced* | No | | *Read-only* | No | ### use-ssl | | | | ----------------------- | ----------------------------------------------------------------------------------- | | *Synopsis* | Indicates whether the Mail Server should use SSL. | | *Description* | If enabled, the Mail Server will use SSL to encrypt communication with the clients. | | *Default value* | false | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | The object must be disabled and re-enabled for changes to take effect. | | *Advanced* | No | | *Read-only* | No | ### use-start-tls | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates whether to use StartTLS. | | *Description* | If enabled, the Mail Server will use the StartTLS command after connecting to initiate secure communication over an otherwise insecure channel. Note that this is only allowed if the Mail Server is not configured to use SSL. | | *Default value* | true | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ## Advanced properties Use the `--advanced` option to access advanced properties. ### smtp-property | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | *Synopsis* | Specifies additional options to pass when submitting messages. | | *Description* | Any supported property can be specified here. Refer to the documentation at for further information on related properties, their implications, and range values. Note these extra properties will be added after the normal properties are set for this Mail Server. | | *Default value* | No additional properties. | | *Allowed values* | A property name followed by an "=" and then the property value. | | *Multi-valued* | Yes | | *Required* | No | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No |