Package io.vertx.rxjava3.ext.mail
Class MailClientBuilder
- java.lang.Object
-
- io.vertx.rxjava3.ext.mail.MailClientBuilder
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class MailClientBuilder extends Object implements io.vertx.lang.rx.RxDelegate
A builder forMailClient.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<MailClientBuilder>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description MailClientBuilder(MailClientBuilder delegate)MailClientBuilder(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MailClientbuild()Build and return the client.booleanequals(Object o)MailClientBuildergetDelegate()inthashCode()static MailClientBuildernewInstance(MailClientBuilder arg)MailClientBuildershared(String poolName)Set a shared client pool name.StringtoString()MailClientBuilderwith(MailConfig configuration)Set a configuration object.MailClientBuilderwithCredentialsSupplier(Supplier<Single<UsernamePasswordCredentials>> credentialsSupplier)Set a credentials supplier for the mail client.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<MailClientBuilder> __TYPE_ARG
-
-
Constructor Detail
-
MailClientBuilder
public MailClientBuilder(MailClientBuilder delegate)
-
MailClientBuilder
public MailClientBuilder(Object delegate)
-
-
Method Detail
-
getDelegate
public MailClientBuilder getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
with
public MailClientBuilder with(MailConfig configuration)
Set a configuration object.- Parameters:
configuration- to be used for sending mails- Returns:
- a reference to this, so the API can be used fluently
-
withCredentialsSupplier
public MailClientBuilder withCredentialsSupplier(Supplier<Single<UsernamePasswordCredentials>> credentialsSupplier)
Set a credentials supplier for the mail client.By default, the credentials are fixed at creation time with
MailConfigandMailConfig.- Parameters:
credentialsSupplier-- Returns:
- a reference to this, so the API can be used fluently
-
shared
public MailClientBuilder shared(String poolName)
Set a shared client pool name.The created client will share its connection pool with any other client created with the same pool name.
- Parameters:
poolName- the shared pool name- Returns:
- a reference to this, so the API can be used fluently
-
build
public MailClient build()
Build and return the client.- Returns:
- the client as configured by this builder
-
newInstance
public static MailClientBuilder newInstance(MailClientBuilder arg)
-
-