- 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
- 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
- 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
- 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
- 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
- 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
- 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
-
- 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
- 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
- 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
- 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
- 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(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
-
- 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
-
- 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
- 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)
- 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
- 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.
- 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
-
- setName(String) - Method in interface io.vertx.ext.mail.MailAttachment
-
set the name
- 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.
- 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.
- 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
-
- StartTLSOptions - Enum in io.vertx.ext.mail
-
possible options for a secure connection using TLS
either DISABLED, OPTIONAL or REQUIRED