Skip navigation links
vertx-mail-client 3.8.1.redhat-00005
A C D E G H I L M S T V 

A

addHeader(String, String) - Method in class 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.

C

close() - Method in interface io.vertx.ext.mail.MailClient
close the MailClient
createNonShared(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_POOL_NAME - Static variable in interface io.vertx.ext.mail.MailClient
The name of the default pool

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
equals(Object) - Method in class io.vertx.ext.mail.MailAttachment
 
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
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
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 class io.vertx.ext.mail.MailAttachment
get the Content-ID field
getContentType() - Method in class io.vertx.ext.mail.MailAttachment
get the Content-Type
getData() - Method in class io.vertx.ext.mail.MailAttachment
get the data
getDescription() - Method in class io.vertx.ext.mail.MailAttachment
get the description field
getDisposition() - Method in class io.vertx.ext.mail.MailAttachment
get the disposition field
getEmail() - Method in class io.vertx.ext.mail.mailencoder.EmailAddress
get the email part of the address
getFrom() - Method in class io.vertx.ext.mail.MailMessage
get from address of this mail
getHeaders() - Method in class 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
getKeyStore() - Method in class io.vertx.ext.mail.MailConfig
get the key store filename to be used when opening SMTP connections
getKeyStorePassword() - Method in class io.vertx.ext.mail.MailConfig
get the key store password to be used when opening SMTP connections
getLogin() - Method in class io.vertx.ext.mail.MailConfig
get login options
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 class 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
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
getPort() - Method in class io.vertx.ext.mail.MailConfig
get the port of the mailserver
getRecipients() - Method in class io.vertx.ext.mail.MailResult
 
getStarttls() - Method in class io.vertx.ext.mail.MailConfig
get security (TLS) options
getSubject() - Method in class io.vertx.ext.mail.MailMessage
get the subject of this mail
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
getUsername() - Method in class io.vertx.ext.mail.MailConfig
get username

H

hashCode() - Method in class io.vertx.ext.mail.MailAttachment
 
hashCode() - Method in class io.vertx.ext.mail.MailConfig
 
hashCode() - Method in class io.vertx.ext.mail.MailMessage
 

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)
isDisableEsmtp() - Method in class io.vertx.ext.mail.MailConfig
get if ESMTP should be tried as first command (EHLO) (default is true)
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
isSsl() - Method in class io.vertx.ext.mail.MailConfig
get whether ssl is used on connect
isTrustAll() - Method in class io.vertx.ext.mail.MailConfig
get whether to trust all certificates on ssl connect

L

LoginOption - Enum in io.vertx.ext.mail
possible options for a login into a SMTP server
either DISABLED, OPTIONAL, REQUIRED or XOAUTH2

M

MailAttachment - Class in io.vertx.ext.mail
Represent a mail attachment that can be used in a MailMessage.
MailAttachment() - Constructor for class io.vertx.ext.mail.MailAttachment
construct an empty MailAttachment object that can be filled with the setters
MailAttachment(MailAttachment) - Constructor for class io.vertx.ext.mail.MailAttachment
create a copy of a MailAttachment object
MailAttachment(JsonObject) - Constructor for class io.vertx.ext.mail.MailAttachment
create a MailAttachment object from a JsonObject representation
MailClient - Interface in io.vertx.ext.mail
SMTP mail client for Vert.x
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
MailEncoder(MailMessage, 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(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
 

S

sendMail(MailMessage, Handler<AsyncResult<MailResult>>) - 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(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
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
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
setContentId(String) - Method in class io.vertx.ext.mail.MailAttachment
set the Content-ID field to be used in the attachment
setContentType(String) - Method in class io.vertx.ext.mail.MailAttachment
set the Content-Type
setData(Buffer) - Method in class io.vertx.ext.mail.MailAttachment
set the data
setDescription(String) - Method in class 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 class io.vertx.ext.mail.MailAttachment
set the disposition field to be used in the attachment
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
setHeaders(MultiMap) - Method in class 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.
setHtml(String) - Method in class io.vertx.ext.mail.MailMessage
set the html text of this mail
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
setKeepAlive(boolean) - Method in class io.vertx.ext.mail.MailConfig
set if connection pool is enabled default is true
setKeyStore(String) - Method in class io.vertx.ext.mail.MailConfig
get the key store filename to be used when opening SMTP connections
setKeyStorePassword(String) - Method in class io.vertx.ext.mail.MailConfig
get the key store password to be used when opening SMTP connections
setLogin(LoginOption) - Method in class io.vertx.ext.mail.MailConfig
Set the login mode for the connection.
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
 
setName(String) - Method in class io.vertx.ext.mail.MailAttachment
set the name
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.
setPort(int) - Method in class io.vertx.ext.mail.MailConfig
Set the port of the smtp server.
setRecipients(List<String>) - Method in class io.vertx.ext.mail.MailResult
 
setSsl(boolean) - Method in class io.vertx.ext.mail.MailConfig
Set the sslOnConnect mode for the connection.
setStarttls(StartTLSOptions) - Method in class io.vertx.ext.mail.MailConfig
Set the tls security mode for the connection.
setSubject(String) - Method in class io.vertx.ext.mail.MailMessage
set the subject of this mail
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
setTrustAll(boolean) - Method in class io.vertx.ext.mail.MailConfig
set whether to trust all certificates on ssl connect the option is also applied to STARTTLS operation
setUsername(String) - Method in class io.vertx.ext.mail.MailConfig
Set the username for the login.
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.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
 

V

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.StartTLSOptions
Returns the enum constant of this type with the specified name.
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.StartTLSOptions
Returns an array containing the constants of this enum type, in the order they are declared.
A C D E G H I L M S T V 
Skip navigation links
vertx-mail-client 3.8.1.redhat-00005

Copyright © 2019 Eclipse. All rights reserved.