Sets DKIMSignOptions.
set string of allowed auth methods. if set only these methods will be used if the server supports them. If null or empty all supported methods may be used
Sets one DKIMSignOptions for convenient.
Sets DKIMSignOptions.
Set the hostname of the smtp server.
Set the keep alive timeout for SMTP connection, Defaults in seconds.
This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of0
means there is no timeout.
Sets TimeUnit
of keeping connections in the pool alive.
get the key store filename to be used when opening SMTP connections
if not set, an options object will be created based on other settings (ssl and trustAll)
get the key store password to be used when opening SMTP connections
Set the login mode for the connection.
Either DISABLED, OPTIONAL or REQUIRED
Sets the max emails count per connection before it gets closed.
Some SMTP servers have requirement to allow only a number of emails sent per connection.
set the max allowed number of open connections to the mail server if not set the default is 10
Sets the domain used on NTLM authentication
set the hostname to be used for HELO/EHLO and the Message-ID
Set the password for the login.
Set the connection pool cleaner period, defaults in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.
Sets the TimeUnit
of pool cleaning period.
Set the port of the smtp server.
Set the tls security mode for the connection.
Either NONE, OPTIONAL or REQUIRED
Sets the Mail User Agent(MUA) name.
It is used to generate the boundary in case of MultiPart email and the Message-ID.
If null
is set, DEFAULT_USER_AGENT is used.
Set the username for the login.
Sets the workstation used on NTLM authentication
set if sending allows rcpt errors
if true, the mail will be sent to the recipients that the server accepted, if any
set if ESMTP should be tried as first command (EHLO)
rfc 1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use old SMTP. If there is a server that does not support EHLO and does not give an error code back, the connection should be closed and retried with HELO. We do not do that and rather support turning off ESMTP with a setting. The odds of this actually happening are very small since the client will not connect to arbitrary smtp hosts on the internet. Since the client knows that is connects to a host that doesn't support ESMTP/EHLO in that way, the property has to be set to false.
Sets true to enable DKIM Signatures, sets false to disable it.
This is used most for temporary disable DKIM without removing DKIM opations from current config.
set if connection pool is enabled default is true
if the connection pooling is disabled, the max number of sockets is enforced nevertheless
Sets to encode multipart only or not.
When sets to true
, the mail message will be encoded as multipart even for simple mails without
attachments, see https://github.com/vert-x3/vertx-mail-client/issues/161.
Sets to enable/disable the pipelining capability if SMTP server supports it.
set if sending allows rcpt errors
if true, the mail will be sent to the recipients that the server accepted, if any
set string of allowed auth methods. if set only these methods will be used if the server supports them. If null or empty all supported methods may be used
Sets one DKIMSignOptions for convenient.
Sets DKIMSignOptions.
set if ESMTP should be tried as first command (EHLO)
rfc 1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use old SMTP. If there is a server that does not support EHLO and does not give an error code back, the connection should be closed and retried with HELO. We do not do that and rather support turning off ESMTP with a setting. The odds of this actually happening are very small since the client will not connect to arbitrary smtp hosts on the internet. Since the client knows that is connects to a host that doesn't support ESMTP/EHLO in that way, the property has to be set to false.
Sets true to enable DKIM Signatures, sets false to disable it.
This is used most for temporary disable DKIM without removing DKIM opations from current config.
Set the hostname of the smtp server.
set if connection pool is enabled default is true
if the connection pooling is disabled, the max number of sockets is enforced nevertheless
Set the keep alive timeout for SMTP connection, Defaults in seconds.
This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of0
means there is no timeout.
Sets TimeUnit
of keeping connections in the pool alive.
get the key store filename to be used when opening SMTP connections
if not set, an options object will be created based on other settings (ssl and trustAll)
get the key store password to be used when opening SMTP connections
Set the login mode for the connection.
Either DISABLED, OPTIONAL or REQUIRED
Sets the max emails count per connection before it gets closed.
Some SMTP servers have requirement to allow only a number of emails sent per connection.
set the max allowed number of open connections to the mail server if not set the default is 10
Sets to encode multipart only or not.
When sets to true
, the mail message will be encoded as multipart even for simple mails without
attachments, see https://github.com/vert-x3/vertx-mail-client/issues/161.
Sets the domain used on NTLM authentication
set the hostname to be used for HELO/EHLO and the Message-ID
Set the password for the login.
Sets to enable/disable the pipelining capability if SMTP server supports it.
Set the connection pool cleaner period, defaults in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.
Sets the TimeUnit
of pool cleaning period.
Set the port of the smtp server.
Set the tls security mode for the connection.
Either NONE, OPTIONAL or REQUIRED
Sets the Mail User Agent(MUA) name.
It is used to generate the boundary in case of MultiPart email and the Message-ID.
If null
is set, DEFAULT_USER_AGENT is used.
Set the username for the login.
Sets the workstation used on NTLM authentication
Generated using TypeDoc
represents the configuration of a mail service with mail server hostname, port, security options, login options and login/password