Skip navigation links
A B C D E G H I L M P R S T U V 

A

addCopiedHeader(String) - Method in class io.vertx.ext.mail.DKIMSignOptions
Adds a copied header.
addCrlPath(String) - Method in class io.vertx.ext.mail.MailConfig
 
addCrlValue(Buffer) - Method in class io.vertx.ext.mail.MailConfig
 
addDKIMSignOption(DKIMSignOptions) - Method in class io.vertx.ext.mail.MailConfig
Adds a DKIMSignOptions.
addEnabledCipherSuite(String) - Method in class io.vertx.ext.mail.MailConfig
 
addEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.mail.MailConfig
 
addHeader(String, String) - Method in interface io.vertx.ext.mail.MailAttachment
Add an header to this attachment.
addHeader(String, String) - Method in class io.vertx.ext.mail.MailMessage
Add a message header.
addSignedHeader(String) - Method in class io.vertx.ext.mail.DKIMSignOptions
Adds the signed header
algoName() - Method in enum io.vertx.ext.mail.CanonicalizationAlgorithm
Gets the canonicalization algorithm representation.

B

base64(byte[]) - Static method in class io.vertx.ext.mail.mailencoder.Utils
 
body() - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
 
bodyStream(Context) - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
 
boundary() - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
 

C

CanonicalizationAlgorithm - Enum in io.vertx.ext.mail
Canonicalization Algorithm for DKIM.
close() - Method in interface io.vertx.ext.mail.MailClient
Same as MailClient.close(Handler) but returning a Future
close(Handler<AsyncResult<Void>>) - Method in interface io.vertx.ext.mail.MailClient
Close the MailClient
create() - Static method in interface io.vertx.ext.mail.MailAttachment
construct an empty MailAttachment object that can be filled with the setters
create(JsonObject) - Static method in interface io.vertx.ext.mail.MailAttachment
create a MailAttachment object from a JsonObject representation
create(MailAttachment) - Static method in interface io.vertx.ext.mail.MailAttachment
create a copy of a MailAttachment object
create(Vertx, MailConfig) - Static method in interface io.vertx.ext.mail.MailClient
Create a non shared instance of the mail client.
createShared(Vertx, MailConfig, String) - Static method in interface io.vertx.ext.mail.MailClient
Create a Mail client which shares its connection pool with any other Mail clients created with the same pool name
createShared(Vertx, MailConfig) - Static method in interface io.vertx.ext.mail.MailClient

D

DEFAULT_ALLOW_RCPT_ERRORS - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_DISABLE_ESMTP - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_ENABLE_PIPELINING - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_HOST - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_KEEP_ALIVE - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_KEEP_ALIVE_TIMEOUT - Static variable in class io.vertx.ext.mail.MailConfig
The default keep alive timeout for SMTP connection = 5 minutes
DEFAULT_KEEP_ALIVE_TIMEOUT_UNIT - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_LOGIN - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_MAILS_PER_CONNECTION - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_MAX_POOL_SIZE - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_MULTI_PART_ONLY - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_POOL_CLEANER_PERIOD - Static variable in class io.vertx.ext.mail.MailConfig
Default pool cleaner period = 1000 ms (1 second)
DEFAULT_POOL_CLEANER_PERIOD_TIMEOUT_UNIT - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_POOL_NAME - Static variable in interface io.vertx.ext.mail.MailClient
The name of the default pool
DEFAULT_PORT - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_TLS - Static variable in class io.vertx.ext.mail.MailConfig
 
DEFAULT_USER_AGENT - Static variable in class io.vertx.ext.mail.MailConfig
 
dkimAlgoName() - Method in enum io.vertx.ext.mail.DKIMSignAlgorithm
Gets the algorithm name specified by the DKIM specification.
dkimBodyStream(Context) - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
 
DKIMSignAlgorithm - Enum in io.vertx.ext.mail
Signing Algorithm specified by DKIM spec.
DKIMSignOptions - Class in io.vertx.ext.mail
This represents the options used to perform DKIM Signature signing action.
DKIMSignOptions() - Constructor for class io.vertx.ext.mail.DKIMSignOptions
Default Constructor.
DKIMSignOptions(DKIMSignOptions) - Constructor for class io.vertx.ext.mail.DKIMSignOptions
 
DKIMSignOptions(JsonObject) - Constructor for class io.vertx.ext.mail.DKIMSignOptions
Constructor from a JsonObject.
DKIMSignOptionsConverter - Class in io.vertx.ext.mail
Converter and mapper for DKIMSignOptions.
DKIMSignOptionsConverter() - Constructor for class io.vertx.ext.mail.DKIMSignOptionsConverter
 

E

EmailAddress - Class in io.vertx.ext.mail.mailencoder
represent a mail address with an email address part and an optional full name e.g.
EmailAddress(String) - Constructor for class io.vertx.ext.mail.mailencoder.EmailAddress
parse and create an email address
encode() - Method in class io.vertx.ext.mail.mailencoder.MailEncoder
encode the MailMessage to a String
EncodedPart - Class in io.vertx.ext.mail.mailencoder
This is implementation detail class.
EncodedPart() - Constructor for class io.vertx.ext.mail.mailencoder.EncodedPart
 
encodeMail() - Method in class io.vertx.ext.mail.mailencoder.MailEncoder
 
encodeQP(String) - Static method in class io.vertx.ext.mail.mailencoder.Utils
 
equals(Object) - Method in class io.vertx.ext.mail.DKIMSignOptions
 
equals(Object) - Method in class io.vertx.ext.mail.MailConfig
 
equals(Object) - Method in class io.vertx.ext.mail.MailMessage
 

G

getAttachment() - Method in class io.vertx.ext.mail.MailMessage
get the list of attachments of this mail
getAuid() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the Agent or User Identifier(AUID)
getAuthMethods() - Method in class io.vertx.ext.mail.MailConfig
get string of allowed auth methods, if set only these methods will be used if the server supports them.
getBcc() - Method in class io.vertx.ext.mail.MailMessage
get list of bcc addresses
getBodyCanonAlgo() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the canonicalization algorithm for mail body.
getBodyLimit() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the body limit to sign.
getBounceAddress() - Method in class io.vertx.ext.mail.MailMessage
get bounce address of this mail
getCc() - Method in class io.vertx.ext.mail.MailMessage
get list of cc addresses
getContentId() - Method in interface io.vertx.ext.mail.MailAttachment
get the Content-ID field
getContentType() - Method in interface io.vertx.ext.mail.MailAttachment
get the Content-Type
getCopiedHeaders() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the copied headers used in DKIM.
getData() - Method in interface io.vertx.ext.mail.MailAttachment
get the data
getDescription() - Method in interface io.vertx.ext.mail.MailAttachment
get the description field
getDetail() - Method in enum io.vertx.ext.mail.SMTPException.EnhancedStatus
Gets detail number of the EnhancedStatus.
getDisposition() - Method in interface io.vertx.ext.mail.MailAttachment
get the disposition field
getDKIMSignOption() - Method in class io.vertx.ext.mail.MailConfig
Gets the DKIM options.
getDKIMSignOptions() - Method in class io.vertx.ext.mail.MailConfig
Gets the DKIM options.
getEmail() - Method in class io.vertx.ext.mail.mailencoder.EmailAddress
get the email part of the address
getEnhancedStatus() - Method in class io.vertx.ext.mail.SMTPException
EnhancedStatus of the exception.
getExpireTime() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the expire time in seconds when the signature sign will be expired.
getFrom() - Method in class io.vertx.ext.mail.MailMessage
get from address of this mail
getHeaderCanonAlgo() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the canonicalization algorithm for signed headers.
getHeaders() - Method in interface io.vertx.ext.mail.MailAttachment
Get the headers to be added for this attachment.
getHeaders() - Method in class io.vertx.ext.mail.MailMessage
Get the headers.
getHostname() - Method in class io.vertx.ext.mail.MailConfig
get the hostname of the mailserver
getHtml() - Method in class io.vertx.ext.mail.MailMessage
get the html text of this mail
getInlineAttachment() - Method in class io.vertx.ext.mail.MailMessage
get the list of inline attachments of this mail
getKeepAliveTimeout() - Method in class io.vertx.ext.mail.MailConfig
 
getKeepAliveTimeoutUnit() - Method in class io.vertx.ext.mail.MailConfig
Gets the TimeUnit of keeping the connections alive timeout.
getKeyStore() - Method in class io.vertx.ext.mail.MailConfig
getKeyStorePassword() - Method in class io.vertx.ext.mail.MailConfig
getLogin() - Method in class io.vertx.ext.mail.MailConfig
get login options
getMaxMailsPerConnection() - Method in class io.vertx.ext.mail.MailConfig
The max emails count per connection.
getMaxPoolSize() - Method in class io.vertx.ext.mail.MailConfig
get the max allowed number of open connections to the mailserver if not set the default is 10
getMessageID() - Method in class io.vertx.ext.mail.mailencoder.MailEncoder
 
getMessageID() - Method in class io.vertx.ext.mail.MailResult
 
getName() - Method in interface io.vertx.ext.mail.MailAttachment
get the name
getName() - Method in class io.vertx.ext.mail.mailencoder.EmailAddress
get the name part of the address
getNtDomain() - Method in class io.vertx.ext.mail.MailConfig
Domain used on NTLM authentication.
getOwnHostname() - Method in class io.vertx.ext.mail.MailConfig
get the hostname to be used for HELO/EHLO and the Message-ID
getPassword() - Method in class io.vertx.ext.mail.MailConfig
get password
getPoolCleanerPeriod() - Method in class io.vertx.ext.mail.MailConfig
 
getPoolCleanerPeriodUnit() - Method in class io.vertx.ext.mail.MailConfig
Gets the TimeUnit of pool cleaning period.
getPort() - Method in class io.vertx.ext.mail.MailConfig
get the port of the mailserver
getPrivateKey() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the PKCS#8 format private key used to sign the email.
getPrivateKeyPath() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the PKCS#8 format private key file path.
getRecipients() - Method in class io.vertx.ext.mail.MailResult
 
getReplyCode() - Method in class io.vertx.ext.mail.SMTPException
Gets the SMTP reply status code.
getReplyMessage() - Method in class io.vertx.ext.mail.SMTPException
Gets the SMTP reply message.
getReplyMessages() - Method in class io.vertx.ext.mail.SMTPException
Gets the SMTP reply messages.
getSdid() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the Singing Domain Identifier(SDID).
getSelector() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the selector used to query public key.
getSignAlgo() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the signing algorithm.
getSignedHeaders() - Method in class io.vertx.ext.mail.DKIMSignOptions
Gets the email signedHeaders used to sign.
getSize() - Method in interface io.vertx.ext.mail.MailAttachment
Gets the size of the attachment.
getStarttls() - Method in class io.vertx.ext.mail.MailConfig
get security (TLS) options
getStream() - Method in interface io.vertx.ext.mail.MailAttachment
Gets the data stream.
getSubject() - Method in class io.vertx.ext.mail.MailMessage
get the subject of this mail
getSubject() - Method in enum io.vertx.ext.mail.SMTPException.EnhancedStatus
Gets the subject of the EnhancedStatus.
getText() - Method in class io.vertx.ext.mail.MailMessage
get the plain text of this mail
getTo() - Method in class io.vertx.ext.mail.MailMessage
get list of to addresses
getUserAgent() - Method in class io.vertx.ext.mail.MailConfig
Gets the Mail User Agent(MUA) name that will be used to generate boundary and message id.
getUsername() - Method in class io.vertx.ext.mail.MailConfig
get username
getWorkstation() - Method in class io.vertx.ext.mail.MailConfig
Workstation used on NTLM authentication

H

hashAlgoId() - Method in enum io.vertx.ext.mail.DKIMSignAlgorithm
Gets the Hash Algorithm ID that can be identified by the HashingStrategy.
hashAlgorithm() - Method in enum io.vertx.ext.mail.DKIMSignAlgorithm
Gets the hash algorithm to produce the hash of the message.
hashCode() - Method in class io.vertx.ext.mail.DKIMSignOptions
 
hashCode() - Method in class io.vertx.ext.mail.MailConfig
 
hashCode() - Method in class io.vertx.ext.mail.MailMessage
 
headers() - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
 

I

io.vertx.ext.mail - package io.vertx.ext.mail
 
io.vertx.ext.mail.mailencoder - package io.vertx.ext.mail.mailencoder
 
isAllowRcptErrors() - Method in class io.vertx.ext.mail.MailConfig
get if sending allows rcpt errors (default is false) if true, the mail will be sent to the recipients that the server accepted, if any
isDisableEsmtp() - Method in class io.vertx.ext.mail.MailConfig
get if ESMTP should be tried as first command (EHLO) (default is true) 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.
isEnableDKIM() - Method in class io.vertx.ext.mail.MailConfig
Is DKIM enabled, defaults to false.
isFixedHeaders() - Method in class io.vertx.ext.mail.MailMessage
get whether our own headers should be the only headers added to the message
isKeepAlive() - Method in class io.vertx.ext.mail.MailConfig
get if connection pool is enabled default is true if the connection pooling is disabled, the max number of sockets is enforced nevertheless
isMultiPartOnly() - Method in class io.vertx.ext.mail.MailConfig
Should the mail message be always encoded as multipart.
isPermanent() - Method in class io.vertx.ext.mail.SMTPException
Checks if it is a permanent failure, that the reply status code >= 500
isPipelining() - Method in class io.vertx.ext.mail.MailConfig
Is the pipelining will be used if SMTP server supports it.
isSignatureTimestamp() - Method in class io.vertx.ext.mail.DKIMSignOptions
Adds signature sign timestamp or not.
isTransient() - Method in class io.vertx.ext.mail.SMTPException
Checks if it is a transient failure, that the reply status code >= 400 and < 500

L

LoginOption - Enum in io.vertx.ext.mail
possible options for a login into an SMTP server
either DISABLED, NONE, REQUIRED or XOAUTH2 DISABLED means no login will be attempted NONE means a login will be attempted if the server supports it and login credentials are set REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens

M

MailAttachment - Interface in io.vertx.ext.mail
Represent a mail attachment that can be used in a MailMessage.
MailClient - Interface in io.vertx.ext.mail
SMTP mail client for Vert.x A simple asynchronous API for sending mails from Vert.x applications
MailConfig - Class in io.vertx.ext.mail
represents the configuration of a mail service with mail server hostname, port, security options, login options and login/password
MailConfig() - Constructor for class io.vertx.ext.mail.MailConfig
construct a config object with default options
MailConfig(String) - Constructor for class io.vertx.ext.mail.MailConfig
construct a config object with hostname and default options
MailConfig(String, int) - Constructor for class io.vertx.ext.mail.MailConfig
construct a config object with hostname/port and default options
MailConfig(String, int, StartTLSOptions, LoginOption) - Constructor for class io.vertx.ext.mail.MailConfig
construct a config object with hostname/port and security and login options
MailConfig(MailConfig) - Constructor for class io.vertx.ext.mail.MailConfig
copy config object from another MailConfig object
MailConfig(JsonObject) - Constructor for class io.vertx.ext.mail.MailConfig
construct config object from Json representation
MailEncoder - Class in io.vertx.ext.mail.mailencoder
create MIME mail messages from a MailMessage object example usage is: {@code MailMessage = new MailMessage(); (set elements and attachments ...)
MailEncoder(MailMessage, String) - Constructor for class io.vertx.ext.mail.mailencoder.MailEncoder
create a MailEncoder for the message The class will probably get a few setters for optional features of the SMTP protocol later e.g. 8BIT or SMTPUTF (this is not yet supported)
MailEncoder(MailMessage, String, String) - Constructor for class io.vertx.ext.mail.mailencoder.MailEncoder
create a MailEncoder for the message The class will probably get a few setters for optional features of the SMTP protocol later e.g. 8BIT or SMTPUTF (this is not yet supported)
MailEncoder(MailMessage, String, MailConfig) - Constructor for class io.vertx.ext.mail.mailencoder.MailEncoder
Creates a MailEncoder for the message.
MailMessage - Class in io.vertx.ext.mail
represent a mail message that can be sent via the MailClient
MailMessage() - Constructor for class io.vertx.ext.mail.MailMessage
construct empty mail message that can be used with the setters
MailMessage(MailMessage) - Constructor for class io.vertx.ext.mail.MailMessage
copy object to another @link MailMessage object
MailMessage(JsonObject) - Constructor for class io.vertx.ext.mail.MailMessage
construct object from a JsonObject representation
MailMessage(String, String, String, String) - Constructor for class io.vertx.ext.mail.MailMessage
construct a simple message with text/plain
MailResult - Class in io.vertx.ext.mail
Represent the result of the sendMail operation
MailResult() - Constructor for class io.vertx.ext.mail.MailResult
 
MailResult(MailResult) - Constructor for class io.vertx.ext.mail.MailResult
 
MailResult(JsonObject) - Constructor for class io.vertx.ext.mail.MailResult
 

P

parts() - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
 
POSTMASTER - Static variable in class io.vertx.ext.mail.mailencoder.EmailAddress
 

R

removeEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.mail.MailConfig
 

S

sendMail(MailMessage, Handler<AsyncResult<MailResult>>) - Method in interface io.vertx.ext.mail.MailClient
send a single mail via MailClient
sendMail(MailMessage) - Method in interface io.vertx.ext.mail.MailClient
Same as MailClient.sendMail(MailMessage, Handler) but returning a Future.
setAllowRcptErrors(boolean) - Method in class io.vertx.ext.mail.MailConfig
set if sending allows rcpt errors if true, the mail will be sent to the recipients that the server accepted, if any
setAttachment(List<MailAttachment>) - Method in class io.vertx.ext.mail.MailMessage
set the list of attachments of this mail
setAttachment(MailAttachment) - Method in class io.vertx.ext.mail.MailMessage
set a single attachment of this mail
setAuid(String) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the Agent or User Identifier(AUID)
setAuthMethods(String) - Method in class io.vertx.ext.mail.MailConfig
set string of allowed auth methods.
setBcc(List<String>) - Method in class io.vertx.ext.mail.MailMessage
set list of bcc addresses
setBcc(String) - Method in class io.vertx.ext.mail.MailMessage
helper method for single recipient
setBodyCanonAlgo(CanonicalizationAlgorithm) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the canonicalization algorithm for mail body.
setBodyLimit(int) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the body limit to sign.
setBounceAddress(String) - Method in class io.vertx.ext.mail.MailMessage
set bounce address of this mail
setCc(List<String>) - Method in class io.vertx.ext.mail.MailMessage
set list of cc addresses
setCc(String) - Method in class io.vertx.ext.mail.MailMessage
helper method for single recipient
setConnectTimeout(int) - Method in class io.vertx.ext.mail.MailConfig
 
setContentId(String) - Method in interface io.vertx.ext.mail.MailAttachment
set the Content-ID field to be used in the attachment
setContentType(String) - Method in interface io.vertx.ext.mail.MailAttachment
set the Content-Type
setCopiedHeaders(List<String>) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the copied headers used in DKIM.
setData(Buffer) - Method in interface io.vertx.ext.mail.MailAttachment
set the data
setDescription(String) - Method in interface io.vertx.ext.mail.MailAttachment
set the description field to be used in the attachment
setDisableEsmtp(boolean) - Method in class io.vertx.ext.mail.MailConfig
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.
setDisposition(String) - Method in interface io.vertx.ext.mail.MailAttachment
set the disposition field to be used in the attachment
setDKIMSignOption(DKIMSignOptions) - Method in class io.vertx.ext.mail.MailConfig
Sets one DKIMSignOptions for convenient.
setDKIMSignOptions(List<DKIMSignOptions>) - Method in class io.vertx.ext.mail.MailConfig
Sets DKIMSignOptions.
setEnableDKIM(boolean) - Method in class io.vertx.ext.mail.MailConfig
Sets true to enable DKIM Signatures, sets false to disable it.
setEnabledSecureTransportProtocols(Set<String>) - Method in class io.vertx.ext.mail.MailConfig
 
setExpireTime(long) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the expire time in seconds when the signature sign will be expired.
setFixedHeaders(boolean) - Method in class io.vertx.ext.mail.MailMessage
set whether our own headers should be the only headers added to the message
setFrom(String) - Method in class io.vertx.ext.mail.MailMessage
set from address of this mail
setHeaderCanonAlgo(CanonicalizationAlgorithm) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the canonicalization algorithm for signed headers.
setHeaders(MultiMap) - Method in interface io.vertx.ext.mail.MailAttachment
Set the headers to be added for this attachment.
setHeaders(MultiMap) - Method in class io.vertx.ext.mail.MailMessage
Set the headers.
setHostname(String) - Method in class io.vertx.ext.mail.MailConfig
Set the hostname of the smtp server.
setHostnameVerificationAlgorithm(String) - Method in class io.vertx.ext.mail.MailConfig
 
setHtml(String) - Method in class io.vertx.ext.mail.MailMessage
set the html text of this mail
setIdleTimeout(int) - Method in class io.vertx.ext.mail.MailConfig
 
setIdleTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.mail.MailConfig
 
setInlineAttachment(List<MailAttachment>) - Method in class io.vertx.ext.mail.MailMessage
set the list of inline attachments of this mail
setInlineAttachment(MailAttachment) - Method in class io.vertx.ext.mail.MailMessage
set a single inline attachment of this mail
setJdkSslEngineOptions(JdkSSLEngineOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setKeepAlive(boolean) - Method in class io.vertx.ext.mail.MailConfig
set if connection pool is enabled default is true if the connection pooling is disabled, the max number of sockets is enforced nevertheless
setKeepAliveTimeout(int) - Method in class io.vertx.ext.mail.MailConfig
Set the keep alive timeout for SMTP connection, Defaults in seconds.
setKeepAliveTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.mail.MailConfig
Sets TimeUnit of keeping connections in the pool alive.
setKeyCertOptions(KeyCertOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setKeyStore(String) - Method in class io.vertx.ext.mail.MailConfig
setKeyStoreOptions(JksOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setKeyStorePassword(String) - Method in class io.vertx.ext.mail.MailConfig
setLocalAddress(String) - Method in class io.vertx.ext.mail.MailConfig
 
setLogActivity(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setLogin(LoginOption) - Method in class io.vertx.ext.mail.MailConfig
Set the login mode for the connection.
setMaxMailsPerConnection(long) - Method in class io.vertx.ext.mail.MailConfig
Sets the max emails count per connection before it gets closed.
setMaxPoolSize(int) - Method in class io.vertx.ext.mail.MailConfig
set the max allowed number of open connections to the mail server if not set the default is 10
setMessageID(String) - Method in class io.vertx.ext.mail.MailResult
 
setMetricsName(String) - Method in class io.vertx.ext.mail.MailConfig
 
setMultiPartOnly(boolean) - Method in class io.vertx.ext.mail.MailConfig
Sets to encode multipart only or not.
setName(String) - Method in interface io.vertx.ext.mail.MailAttachment
set the name
setNtDomain(String) - Method in class io.vertx.ext.mail.MailConfig
Sets the domain used on NTLM authentication
setOpenSslEngineOptions(OpenSSLEngineOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setOwnHostname(String) - Method in class io.vertx.ext.mail.MailConfig
set the hostname to be used for HELO/EHLO and the Message-ID
setPassword(String) - Method in class io.vertx.ext.mail.MailConfig
Set the password for the login.
setPemKeyCertOptions(PemKeyCertOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setPemTrustOptions(PemTrustOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setPfxKeyCertOptions(PfxOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setPfxTrustOptions(PfxOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setPipelining(boolean) - Method in class io.vertx.ext.mail.MailConfig
Sets to enable/disable the pipelining capability if SMTP server supports it.
setPoolCleanerPeriod(int) - Method in class io.vertx.ext.mail.MailConfig
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.
setPoolCleanerPeriodUnit(TimeUnit) - Method in class io.vertx.ext.mail.MailConfig
Sets the TimeUnit of pool cleaning period.
setPort(int) - Method in class io.vertx.ext.mail.MailConfig
Set the port of the smtp server.
setPrivateKey(String) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the PKCS#8 format private key used to sign the email.
setPrivateKeyPath(String) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the PKCS#8 format private key file path.
setProxyOptions(ProxyOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setReceiveBufferSize(int) - Method in class io.vertx.ext.mail.MailConfig
 
setRecipients(List<String>) - Method in class io.vertx.ext.mail.MailResult
 
setReconnectAttempts(int) - Method in class io.vertx.ext.mail.MailConfig
 
setReconnectInterval(long) - Method in class io.vertx.ext.mail.MailConfig
 
setReuseAddress(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setReusePort(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setSdid(String) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the Singing Domain Identifier(SDID).
setSelector(String) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the selector used to query the public key.
setSendBufferSize(int) - Method in class io.vertx.ext.mail.MailConfig
 
setSignAlgo(DKIMSignAlgorithm) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the signing algorithm.
setSignatureTimestamp(boolean) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets to enable or disable signature sign timestmap.
setSignedHeaders(List<String>) - Method in class io.vertx.ext.mail.DKIMSignOptions
Sets the email signedHeaders used to sign.
setSize(int) - Method in interface io.vertx.ext.mail.MailAttachment
Sets the size of the attachment.
setSoLinger(int) - Method in class io.vertx.ext.mail.MailConfig
 
setSsl(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setSslEngineOptions(SSLEngineOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setSslHandshakeTimeout(long) - Method in class io.vertx.ext.mail.MailConfig
 
setSslHandshakeTimeoutUnit(TimeUnit) - Method in class io.vertx.ext.mail.MailConfig
 
setStarttls(StartTLSOptions) - Method in class io.vertx.ext.mail.MailConfig
Set the tls security mode for the connection.
setStream(ReadStream<Buffer>) - Method in interface io.vertx.ext.mail.MailAttachment
Sets the data stream.
setSubject(String) - Method in class io.vertx.ext.mail.MailMessage
set the subject of this mail
setTcpCork(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setTcpFastOpen(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setTcpKeepAlive(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setTcpNoDelay(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setTcpQuickAck(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setText(String) - Method in class io.vertx.ext.mail.MailMessage
set the plain text of this mail
setTo(List<String>) - Method in class io.vertx.ext.mail.MailMessage
set list of to addresses
setTo(String) - Method in class io.vertx.ext.mail.MailMessage
helper method for single recipient
setTrafficClass(int) - Method in class io.vertx.ext.mail.MailConfig
 
setTrustAll(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setTrustOptions(TrustOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setTrustStoreOptions(JksOptions) - Method in class io.vertx.ext.mail.MailConfig
 
setUseAlpn(boolean) - Method in class io.vertx.ext.mail.MailConfig
 
setUserAgent(String) - Method in class io.vertx.ext.mail.MailConfig
Sets the Mail User Agent(MUA) name.
setUsername(String) - Method in class io.vertx.ext.mail.MailConfig
Set the username for the login.
setWorkstation(String) - Method in class io.vertx.ext.mail.MailConfig
Sets the workstation used on NTLM authentication
signatureAlgorithm() - Method in enum io.vertx.ext.mail.DKIMSignAlgorithm
Gets the Signature Algorithm, like: SHA256withRSA, SHA1withRSA.
size() - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
 
SMTPException - Class in io.vertx.ext.mail
This represents an Exception during communication with SMTP server.
SMTPException(String, int, List<String>, boolean) - Constructor for class io.vertx.ext.mail.SMTPException
Constructor of SMTPException.
SMTPException.EnhancedStatus - Enum in io.vertx.ext.mail
The Enhanced Status codes.
StartTLSOptions - Enum in io.vertx.ext.mail
possible options for a secure connection using TLS
either DISABLED, OPTIONAL or REQUIRED DISABLED means STARTTLS will not be used in any case OPTIONAL means STARTTLS will be used if the server supports it and a plain connection will be used otherwise; please note that this option is not as secure as it seems since a MITM attacker can remove the STARTTLS line from the capabilities reply.

T

toJson() - Method in class io.vertx.ext.mail.DKIMSignOptions
Converts to JsonObject
toJson() - Method in interface io.vertx.ext.mail.MailAttachment
convert this object to JSON representation
toJson() - Method in class io.vertx.ext.mail.MailConfig
convert config object to Json representation
toJson() - Method in class io.vertx.ext.mail.MailMessage
convert the mail message to Json representation
toJson() - Method in class io.vertx.ext.mail.MailResult
 
toString() - Method in class io.vertx.ext.mail.mailencoder.EmailAddress
get a representation of the address (this is mostly for testing)
toString() - Method in class io.vertx.ext.mail.MailResult
 

U

Utils - Class in io.vertx.ext.mail.mailencoder
 

V

valueOf(String) - Static method in enum io.vertx.ext.mail.CanonicalizationAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.mail.DKIMSignAlgorithm
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.mail.LoginOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.mail.SMTPException.EnhancedStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.mail.StartTLSOptions
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.vertx.ext.mail.CanonicalizationAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.mail.DKIMSignAlgorithm
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.mail.LoginOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.mail.SMTPException.EnhancedStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.mail.StartTLSOptions
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E G H I L M P R S T U V 
Skip navigation links

Copyright © 2025 Eclipse. All rights reserved.