public class MailClient extends Object
A simple asynchronous API for sending mails from Vert.x applications
NOTE: This class has been automatically generated from theoriginal
non RX-ified interface using Vert.x codegen.Constructor and Description |
---|
MailClient(MailClient delegate) |
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.rxjava.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.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
|
Object |
getDelegate() |
static MailClient |
newInstance(MailClient arg) |
MailClient |
sendMail(MailMessage email,
Handler<AsyncResult<MailResult>> resultHandler)
send a single mail via MailClient
|
rx.Observable<MailResult> |
sendMailObservable(MailMessage email)
send a single mail via MailClient
|
public MailClient(MailClient delegate)
public Object getDelegate()
public static MailClient createNonShared(Vertx vertx, MailConfig config)
vertx
- the Vertx instance the operation will be run inconfig
- MailConfig configuration to be used for sending mailspublic static MailClient createShared(Vertx vertx, MailConfig config, String poolName)
vertx
- the Vert.x instanceconfig
- the configurationpoolName
- the pool namepublic static MailClient createShared(Vertx vertx, MailConfig config)
createShared(io.vertx.rxjava.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.String)
but with the default pool namevertx
- the Vert.x instanceconfig
- the configurationpublic MailClient 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)public rx.Observable<MailResult> sendMailObservable(MailMessage email)
email
- MailMessage object containing the mail text, from/to, attachments etcpublic void close()
public static MailClient newInstance(MailClient arg)
Copyright © 2015. All Rights Reserved.