Package io.vertx.ext.mail
Interface MailClient
-
public interface MailClient
SMTP mail client for Vert.xA simple asynchronous API for sending mails from Vert.x applications
- Author:
- Alexander Lehmann
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_POOL_NAME
The name of the default pool
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description Future<Void>
close()
Close the MailClientstatic MailClient
create(Vertx vertx, MailConfig config)
Create a non shared instance of the mail client.static MailClient
createShared(Vertx vertx, MailConfig config)
LikecreateShared(io.vertx.core.Vertx, MailConfig, String)
but with the default pool namestatic MailClient
createShared(Vertx vertx, MailConfig config, String poolName)
Create a Mail client which shares its connection pool with any other Mail clients created with the same pool nameFuture<MailResult>
sendMail(MailMessage email)
send a single mail via MailClient
-
-
-
Field Detail
-
DEFAULT_POOL_NAME
static final String DEFAULT_POOL_NAME
The name of the default pool- See Also:
- Constant Field Values
-
-
Method Detail
-
create
static MailClient create(Vertx vertx, MailConfig config)
Create a non shared instance of the mail client.- Parameters:
vertx
- the Vertx instance the operation will be run inconfig
- MailConfig configuration to be used for sending mails- Returns:
- MailClient instance that can then be used to send multiple mails
-
createShared
static MailClient createShared(Vertx vertx, MailConfig config, String poolName)
Create a Mail client which shares its connection pool with any other Mail clients created with the same pool name- Parameters:
vertx
- the Vert.x instanceconfig
- the configurationpoolName
- the pool name- Returns:
- the client
-
createShared
static MailClient createShared(Vertx vertx, MailConfig config)
LikecreateShared(io.vertx.core.Vertx, MailConfig, String)
but with the default pool name- Parameters:
vertx
- the Vert.x instanceconfig
- the configuration- Returns:
- the client
-
sendMail
Future<MailResult> sendMail(MailMessage email)
send a single mail via MailClient- Parameters:
email
- MailMessage object containing the mail text, from/to, attachments etc- Returns:
- a future notified when the operation is finished or it fails (may be null to ignore the result)
-
-