public interface MailClient
A simple asynchronous API for sending mails from Vert.x applications
| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_POOL_NAME
The name of the default pool
|
| Modifier and Type | Method and Description |
|---|---|
void |
close()
close the MailClient
|
static MailClient |
createNonShared(Vertx vertx,
MailConfig config)
create a non shared instance of the mail client
|
static MailClient |
createShared(Vertx vertx,
MailConfig config)
Like
createShared(io.vertx.core.Vertx, MailConfig, String) but with the default pool name |
static MailClient |
createShared(Vertx vertx,
MailConfig config,
String poolName)
Create a Mail client which shares its data source with any other Mongo clients created with the same
pool name
|
MailClient |
sendMail(MailMessage email,
Handler<AsyncResult<MailResult>> resultHandler)
send a single mail via MailClient
|
static final String DEFAULT_POOL_NAME
static MailClient createNonShared(Vertx vertx, MailConfig config)
vertx - the Vertx instance the operation will be run inconfig - MailConfig configuration to be used for sending mailsstatic MailClient createShared(Vertx vertx, MailConfig config, String poolName)
vertx - the Vert.x instanceconfig - the configurationpoolName - the pool namestatic MailClient createShared(Vertx vertx, MailConfig config)
createShared(io.vertx.core.Vertx, MailConfig, String) but with the default pool namevertx - the Vert.x instanceconfig - the configurationMailClient sendMail(MailMessage email, Handler<AsyncResult<MailResult>> resultHandler)
email - MailMessage object containing the mail text, from/to, attachments etcresultHandler - will be called when the operation is finished or it fails
(may be null to ignore the result)void close()
Copyright © 2015. All rights reserved.