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:

Mail Server Properties

You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.

Basic Properties Advanced Properties

auth-password
auth-username
enabled
smtp-server
trust-manager-provider
use-ssl
use-start-tls

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

true

false

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.

The referenced trust manager provider must be enabled when SSL or StartTLS is enabled.

Multi-valued

No

Required

No

Admin Action Required

None

Changes 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

true

false

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

true

false

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 https://javaee.github.io/javamail/docs/api/javax/mail/package-summary.html#properties 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