Package io.vertx.rxjava3.ext.mail
Class MailClient
- java.lang.Object
-
- io.vertx.rxjava3.ext.mail.MailClient
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class MailClient extends Object implements io.vertx.lang.rx.RxDelegate
SMTP mail client for Vert.xA simple asynchronous API for sending mails from Vert.x applications
NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<MailClient>__TYPE_ARGstatic StringDEFAULT_POOL_NAMEThe name of the default pool
-
Constructor Summary
Constructors Constructor Description MailClient(MailClient delegate)MailClient(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Completableclose()Close the MailClientstatic MailClientcreate(Vertx vertx, MailConfig config)Create a non shared instance of the mail client.static MailClientcreateShared(Vertx vertx, MailConfig config)LikecreateShared(io.vertx.rxjava3.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.String)but with the default pool namestatic MailClientcreateShared(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 namebooleanequals(Object o)MailClientgetDelegate()inthashCode()static MailClientnewInstance(MailClient arg)CompletablerxClose()Close the MailClientSingle<MailResult>rxSendMail(MailMessage email)send a single mail via MailClientSingle<MailResult>sendMail(MailMessage email)send a single mail via MailClientStringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<MailClient> __TYPE_ARG
-
DEFAULT_POOL_NAME
public static final String DEFAULT_POOL_NAME
The name of the default pool- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MailClient
public MailClient(MailClient delegate)
-
MailClient
public MailClient(Object delegate)
-
-
Method Detail
-
getDelegate
public MailClient getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
create
public 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
public 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
public static MailClient createShared(Vertx vertx, MailConfig config)
LikecreateShared(io.vertx.rxjava3.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.String)but with the default pool name- Parameters:
vertx- the Vert.x instanceconfig- the configuration- Returns:
- the client
-
sendMail
public Single<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)
-
rxSendMail
public Single<MailResult> rxSendMail(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)
-
close
public Completable close()
Close the MailClient- Returns:
-
rxClose
public Completable rxClose()
Close the MailClient- Returns:
-
newInstance
public static MailClient newInstance(MailClient arg)
-
-