Advanced Mail Settings

Name

Type

Description

mail.debug

boolean

The initial debug mode. Default is false.

mail.from

String

The return email address of the current user.

mail.mime.address.strict

boolean

Enables strict parsing of message headers. The default is true.

mail.host

String

The default host name of the mail server. Used if the mail.protocol.host property isn't set.

mail.store.protocol

String

Specifies the default message access protocol ("pop3", "pop3s", "imap" or "imaps").

mail.transport.protocol

String

Specifies the default message transport protocol ("smtp" or "smtps").

mail.user

String

The default user name to use when connecting to the mail server. Used if the mail.protocol.user property isn't set.

mail.password

String

The default password to use when connecting to the mail server. Used if the mail.protocol.password property isn't set.

mail.protocol.host

String

The host name of the mail server for the specified protocol. Overrides the mail.host property.

mail.protocol.port

int

The port number of the mail server for the specified protocol. If not specified the protocol's default port number is used.

mail.protocol.user

String

The user name to use when connecting to mail servers using the specified protocol. Overrides the mail.user property.

mail.protocol.password

String

The password to use when connecting to mail servers using the specified protocol. Overrides the mail.password property.

Name

Type

Description

mail.smtp.port

int

The SMTP server port to connect to. Defaults to 25.

mail.smtp.connectiontimeout

int

Socket connection timeout value in milliseconds. Default is infinite timeout.

mail.smtp.timeout

int

Socket I/O timeout value in milliseconds. Default is infinite timeout.

mail.smtp.localhost

String

Local host name used in the SMTP HELO or EHLO command. Should not normally need to be set if your name service is configured properly.

mail.smtp.localaddress

String

Local address (host name) to bind to when creating the SMTP connection. Should not normally need to be set, but useful with multi-homed hosts where it's important to pick a particular local address to bind to.

mail.smtp.localport

int

Local port number to bind to when creating the SMTP connection.

mail.smtp.ehlo

boolean

If false, do not attempt to sign on with the EHLO command. Defaults to true. Normally failure of the EHLO command will fallback to the HELO command; this property exists only for servers that don't fail EHLO properly or don't implement EHLO properly.

mail.smtp.auth

boolean

If true, attempt to authenticate the user using the AUTH command. Defaults to false.

mail.smtp.auth.mechanisms

String

If set, lists the authentication mechanisms to consider, and the order in which to consider them. Only mechanisms supported by the server and supported by the current implementation will be used. The default is "LOGIN PLAIN DIGEST-MD5 NTLM", which includes all the authentication mechanisms supported by the current implementation.

mail.smtp.auth.login.disable

boolean

If true, prevents use of the AUTH LOGIN command. Default is false.

mail.smtp.auth.plain.disable

boolean

If true, prevents use of the AUTH PLAIN command. Default is false.

mail.smtp.auth.digest-md5.disable

boolean

If true, prevents use of the AUTH DIGEST-MD5 command. Default is false.

mail.smtp.auth.ntlm.disable

boolean

If true, prevents use of the AUTH NTLM command. Default is false.

mail.smtp.auth.ntlm.domain

String

The NTLM authentication domain.

mail.smtp.auth.ntlm.flags

int

NTLM protocol-specific flags. See http://curl.haxx.se/rfc/ntlm.html#theNtlmFlags for details.

mail.smtp.submitter

String

The submitter to use in the AUTH tag in the MAIL FROM command. Typically used by a mail relay to pass along information about the original submitter of the message. Mail clients typically do not use this.

mail.smtp.dsn.notify

String

The NOTIFY option to the RCPT command. Either NEVER, or some combination of SUCCESS, FAILURE, and DELAY (separated by commas).

mail.smtp.dsn.ret

String

The RET option to the MAIL command. Either FULL or HDRS.

mail.smtp.allow8bitmime

boolean

If set to true, and the server supports the 8BITMIME extension, text parts of messages that use the "quoted-printable" or "base64" encodings are converted to use "8bit" encoding if they follow the RFC2045 rules for 8bit text.

mail.smtp.sendpartial

boolean

If set to true, and a message has some valid and some invalid addresses, send the message anyway, reporting the partial failure with an exception. If set to false (the default), the message is not sent to any of the recipients if there is an invalid recipient address.

mail.smtp.sasl.enable

boolean

If set to true, attempt to use SASL to choose an authentication mechanism for login. Defaults to false.

mail.smtp.sasl.mechanisms

String

A space or comma separated list of SASL mechanism names to try to use.

mail.smtp.sasl.authorizationid

String

The authorization ID to use in the SASL authentication. If not set, the authentication ID (user name) is used.

mail.smtp.sasl.realm

String

The realm to use with DIGEST-MD5 authentication.

mail.smtp.quitwait

boolean

If set to false, the QUIT command is sent and the connection is immediately closed. If set to true (the default), causes the transport to wait for the response to the QUIT command.

mail.smtp.ssl.enable

boolean

If set to true, use SSL to connect and use the SSL port by default. Defaults to false for the "smtp" protocol and true for the "smtps" protocol.

mail.smtp.ssl.checkserveridentity

boolean

If set to true, check the server identity as specified by RFC 2595. These additional checks based on the content of the server's certificate are intended to prevent man-in-the-middle attacks. Defaults to false.

mail.smtp.ssl.trust

String

If set to "*", all hosts are trusted. If set to a whitespace separated list of hosts, those hosts are trusted. Otherwise, trust depends on the certificate the server presents.

mail.smtp.ssl.socketFactory.port

int

Specifies the port to connect to when using SSL. If not set, the default port will be used.

mail.smtp.ssl.protocols

string

Specifies the SSL protocols that will be enabled for SSL connections. The property value is a whitespace separated list of tokens. Allowed values are SSLv3 and TLSv1.

mail.smtp.ssl.ciphersuites

string

Specifies the SSL cipher suites that will be enabled for SSL connections. The property value is a whitespace separated list of tokens.

mail.smtp.mailextension

String

Extension string to append to the MAIL command. The extension string can be used to specify standard SMTP service extensions as well as vendor-specific extensions. See RFC 1869 and other RFCs that define specific extensions.

mail.smtp.starttls.enable

boolean

If true, enables the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server's certificate. Defaults to false.

mail.smtp.starttls.required

boolean

If true, requires the use of the STARTTLS command. If the server doesn't support the STARTTLS command, or the command fails, the connect method will fail. Defaults to false.

mail.smtp.userset

boolean

If set to true, use the RSET command instead of the NOOP command to check connection state. In some cases sendmail will respond slowly after many NOOP commands; use of RSET avoids this sendmail issue. Defaults to false.

mail.smtp.noop.strict

boolean

If set to true (the default), insist on a 250 response code from the NOOP command to indicate success. The NOOP command is used to determine if the connection is still alive. Some older servers return the wrong response code on success, some servers don't implement the NOOP command at all and so always return a failure code. Set this property to false to handle servers that are broken in this way. Normally, when a server times out a connection, it will send a 421 response code, which the client will see as the response to the next command it issues. Some servers send the wrong failure response code when timing out a connection. Do not set this property to false when dealing with servers that are broken in this way.

Name

Type

Description

mail.pop3.port

int

The POP3 server port to connect to. Defaults to 110.

mail.pop3.connectiontimeout

int

Socket connection timeout value in milliseconds. Default is infinite timeout.

mail.pop3.timeout

int

Socket I/O timeout value in milliseconds. Default is infinite timeout.

mail.pop3.rsetbeforequit

boolean

Send a POP3 RSET command when closing the folder, before sending the QUIT command. Useful with POP3 servers that implicitly mark all messages that are read as "deleted"; this will prevent such messages from being deleted and expunged unless the client requests so. Default is false.

mail.pop3.localaddress

String

Local address (host name) to bind to when creating the POP3 socket. Should not normally need to be set, but useful with multi-homed hosts where it's important to pick a particular local address to bind to.

mail.pop3.localport

int

Local port number to bind to when creating the POP3 socket.

mail.pop3.apop.enable

boolean

If set to true, use APOP instead of USER/PASS to login to the POP3 server, if the POP3 server supports APOP. APOP sends a digest of the password rather than the clear text password. Defaults to false.

mail.pop3.ssl.enable

boolean

If set to true, use SSL to connect and use the SSL port by default. Defaults to false for the "pop3" protocol and true for the "pop3s" protocol.

mail.pop3.ssl.checkserveridentity

boolean

If set to true, check the server identity as specified by RFC 2595. These additional checks based on the content of the server's certificate are intended to prevent man-in-the-middle attacks. Defaults to false.

mail.pop3.ssl.trust

String

If set to "*", all hosts are trusted. If set to a whitespace separated list of hosts, those hosts are trusted. Otherwise, trust depends on the certificate the server presents.

mail.pop3.ssl.socketFactory.port

int

Specifies the port to connect to when using SSL. If not set, the default port will be used.

mail.pop3.ssl.protocols

string

Specifies the SSL protocols that will be enabled for SSL connections. The property value is a whitespace separated list of tokens.

mail.pop3.ssl.ciphersuites

string

Specifies the SSL cipher suites that will be enabled for SSL connections. The property value is a whitespace separated list of tokens.

mail.pop3.starttls.enable

boolean

If true, enables the use of the STLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must configured so that the client will trust the server's certificate. Defaults to false.

mail.pop3.starttls.required

boolean

If true, requires the use of the STLS command. If the server doesn't support the STLS command, or the command fails, the connect method will fail. Defaults to false.

mail.pop3.disabletop

boolean

If set to true, the POP3 TOP command will not be used to fetch message headers. This is useful for POP3 servers that don't properly implement the TOP command, or that provide incorrect information in the TOP command results. Defaults to false.

mail.pop3.disablecapa

boolean

If set to true, the POP3 CAPA command will not be used to fetch server capabilities. This is useful for POP3 servers that don't properly implement the CAPA command, or that provide incorrect information in the CAPA command results. Defaults to false.

mail.pop3.forgettopheaders

boolean

If set to true, the headers that might have been retrieved using the POP3 TOP command will be forgotten and replaced by headers retrieved as part of the POP3 RETR command. Some servers, such as some versions of Microsft Exchange and IBM Lotus Notes, will return slightly different headers each time the TOP or RETR command is used. To allow the POP3 provider to properly parse the message content returned from the RETR command, the headers also returned by the RETR command must be used. Setting this property to true will cause these headers to be used, even if they differ from the headers returned previously as a result of using the TOP command. Defaults to false.

mail.pop3.filecache.enable

boolean

If set to true, the POP3 provider will cache message data in a temporary file rather than in memory. Messages are only added to the cache when accessing the message content. Message headers are always cached in memory (on demand). The file cache is removed when the folder is closed or the Server is stopped. Defaults to false.

mail.pop3.filecache.dir

String

If the file cache is enabled, this property can be used to override the default directory used for temporary files.

mail.pop3.keepmessagecontent

boolean

The content of a message is cached when it is first fetched. Normally the cached content is purged if memory is low, in which case the content will be fetched again if it's needed. If this property is set to true, all cached content will be kept intact, preventing the memory from being reused until the folder is closed. Defaults to false.