Index (Vert.x Mail Client 5.0.5 API)

A B C D E G H I L M N O P R S T U V W X
All Classes All Packages

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
build() - Method in interface io.vertx.ext.mail.MailClientBuilder: Build and return the client.
builder(Vertx) - Static method in interface io.vertx.ext.mail.MailClient: Provide a builder for MailClient.

C

CanonicalizationAlgorithm - Enum in io.vertx.ext.mail: Canonicalization Algorithm for DKIM.
close() - 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(Vertx, MailConfig) - Static method in interface io.vertx.ext.mail.MailClient: Create a non shared instance of the mail client.
create(MailAttachment) - Static method in interface io.vertx.ext.mail.MailAttachment: create a copy of a MailAttachment object
createShared(Vertx, MailConfig) - Static method in interface io.vertx.ext.mail.MailClient: Like MailClient.createShared(io.vertx.core.Vertx, MailConfig, String) but with the default pool name
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

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
DISABLED - io.vertx.ext.mail.LoginOption
DISABLED - io.vertx.ext.mail.StartTLSOptions
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(JsonObject) - Constructor for class io.vertx.ext.mail.DKIMSignOptions: Constructor from a JsonObject.
DKIMSignOptions(DKIMSignOptions) - Constructor for class io.vertx.ext.mail.DKIMSignOptions
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

generateDate() - Static method in class io.vertx.ext.mail.mailencoder.Utils
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 exception 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.
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 exception io.vertx.ext.mail.SMTPException: Gets the SMTP reply status code.
getReplyMessage() - Method in exception io.vertx.ext.mail.SMTPException: Gets the SMTP reply message.
getReplyMessages() - Method in exception 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
io.vertx.mail.client - module io.vertx.mail.client
isAllowRcptErrors() - Method in class io.vertx.ext.mail.MailConfig: get if sending allows rcpt errors (default is false)
isDisableEsmtp() - Method in class io.vertx.ext.mail.MailConfig: get if ESMTP should be tried as first command (EHLO) (default is true)
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
isMultiPartOnly() - Method in class io.vertx.ext.mail.MailConfig: Should the mail message be always encoded as multipart.
isPermanent() - Method in exception 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 exception 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

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
MailClientBuilder - Interface in io.vertx.ext.mail: A builder for MailClient.
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(JsonObject) - Constructor for class io.vertx.ext.mail.MailConfig: construct config object from Json representation
MailConfig(MailConfig) - Constructor for class io.vertx.ext.mail.MailConfig: copy config object from another MailConfig object
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
MailEncoder - Class in io.vertx.ext.mail.mailencoder: create MIME mail messages from a MailMessage object
MailEncoder(MailMessage, String) - Constructor for class io.vertx.ext.mail.mailencoder.MailEncoder: create a MailEncoder for the message
MailEncoder(MailMessage, String, MailConfig) - Constructor for class io.vertx.ext.mail.mailencoder.MailEncoder: Creates a MailEncoder for the message.
MailEncoder(MailMessage, String, String) - Constructor for class io.vertx.ext.mail.mailencoder.MailEncoder: create 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(JsonObject) - Constructor for class io.vertx.ext.mail.MailMessage: construct object from a JsonObject representation
MailMessage(MailMessage) - Constructor for class io.vertx.ext.mail.MailMessage: copy object to another @link MailMessage object
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(JsonObject) - Constructor for class io.vertx.ext.mail.MailResult
MailResult(MailResult) - Constructor for class io.vertx.ext.mail.MailResult
mustEncode(char) - Static method in class io.vertx.ext.mail.mailencoder.Utils

N

NONE - io.vertx.ext.mail.LoginOption

O

OPTIONAL - io.vertx.ext.mail.StartTLSOptions
OTHER_ADDRESS - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.1.x for Address Status errors
OTHER_MAIL_DELIVERY - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.5.x for Mail Delivery Protocol errors
OTHER_MAIL_MESSAGE - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.6.x for Message Content or Message Media errors
OTHER_MAIL_SYSTEM - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.3.x for Mail System errors
OTHER_MAILBOX - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.2.x for Mailbox Status errors
OTHER_NETWORK - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.4.x for Network and Routing errors
OTHER_SECURITY - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.7.x for Security or Policy errors
OTHER_UNDEFINED - io.vertx.ext.mail.SMTPException.EnhancedStatus: x.0.x for Undefined errors
OTHER_UNKNOWN - io.vertx.ext.mail.SMTPException.EnhancedStatus: Anything else is unknown, like failures happen before knowing the capabilities or smtp server reply maliciously.

P

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

R

RELAXED - io.vertx.ext.mail.CanonicalizationAlgorithm
removeEnabledSecureTransportProtocol(String) - Method in class io.vertx.ext.mail.MailConfig
REQUIRED - io.vertx.ext.mail.LoginOption
REQUIRED - io.vertx.ext.mail.StartTLSOptions
RSA_SHA1 - io.vertx.ext.mail.DKIMSignAlgorithm
RSA_SHA256 - io.vertx.ext.mail.DKIMSignAlgorithm

S

sendMail(MailMessage) - Method in interface io.vertx.ext.mail.MailClient: send a single mail via MailClient
setAllowRcptErrors(boolean) - Method in class io.vertx.ext.mail.MailConfig: set if sending allows rcpt errors
setAttachment(MailAttachment) - Method in class io.vertx.ext.mail.MailMessage: set a single attachment of this mail
setAttachment(List<MailAttachment>) - Method in class io.vertx.ext.mail.MailMessage: set the list of attachments 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(String) - Method in class io.vertx.ext.mail.MailMessage: helper method for single recipient
setBcc(List<String>) - Method in class io.vertx.ext.mail.MailMessage: set list of bcc addresses
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(String) - Method in class io.vertx.ext.mail.MailMessage: helper method for single recipient
setCc(List<String>) - Method in class io.vertx.ext.mail.MailMessage: set list of cc addresses
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)
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(MailAttachment) - Method in class io.vertx.ext.mail.MailMessage: set a single inline attachment of this mail
setInlineAttachment(List<MailAttachment>) - Method in class io.vertx.ext.mail.MailMessage: set the list of inline attachments of this mail
setKeepAlive(boolean) - Method in class io.vertx.ext.mail.MailConfig: set if connection pool is enabled default is true
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
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
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.
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(String) - Method in class io.vertx.ext.mail.MailMessage: helper method for single recipient
setTo(List<String>) - Method in class io.vertx.ext.mail.MailMessage: set list of to addresses
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
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
shared(String) - Method in interface io.vertx.ext.mail.MailClientBuilder: Set a shared client pool name.
signatureAlgorithm() - Method in enum io.vertx.ext.mail.DKIMSignAlgorithm: Gets the Signature Algorithm, like: SHA256withRSA, SHA1withRSA.
SIMPLE - io.vertx.ext.mail.CanonicalizationAlgorithm
size() - Method in class io.vertx.ext.mail.mailencoder.EncodedPart
SMTPException - Exception in io.vertx.ext.mail: This represents an Exception during communication with SMTP server.
SMTPException(String, int, List<String>, boolean) - Constructor for exception 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

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.

W

with(MailConfig) - Method in interface io.vertx.ext.mail.MailClientBuilder: Set a configuration object.
withCredentialsSupplier(Supplier<Future<UsernamePasswordCredentials>>) - Method in interface io.vertx.ext.mail.MailClientBuilder: Set a credentials supplier for the mail client.

X

XOAUTH2 - io.vertx.ext.mail.LoginOption

A B C D E G H I L M N O P R S T U V W X
All Classes All Packages