io.vertx.axle.ext.mail

Class MailClient

java.lang.Object

io.vertx.axle.ext.mail.MailClient

public class MailClient
extends Object

SMTP mail client for Vert.x

A simple asynchronous API for sending mails from Vert.x applications

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field and Description
static io.vertx.lang.axle.TypeArg<MailClient>	__TYPE_ARG
static String	DEFAULT_POOL_NAME The name of the default pool

Constructor Summary

Constructors

Constructor and Description
MailClient(io.vertx.ext.mail.MailClient delegate)

Method Summary

Modifier and Type	Method and Description
void	close() close the MailClient
static MailClient	create(Vertx vertx, io.vertx.ext.mail.MailConfig config) Create a non shared instance of the mail client.
static MailClient	createNonShared(Vertx vertx, io.vertx.ext.mail.MailConfig config) Deprecated.
static MailClient	createShared(Vertx vertx, io.vertx.ext.mail.MailConfig config) Like createShared(io.vertx.axle.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.String) but with the default pool name
static MailClient	createShared(Vertx vertx, io.vertx.ext.mail.MailConfig config, String poolName) Create a Mail client which shares its connection pool with any other Mail clients created with the same pool name
boolean	equals(Object o)
io.vertx.ext.mail.MailClient	getDelegate()
int	hashCode()
static MailClient	newInstance(io.vertx.ext.mail.MailClient arg)
CompletionStage<io.vertx.ext.mail.MailResult>	sendMail(io.vertx.ext.mail.MailMessage email) send a single mail via MailClient
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final io.vertx.lang.axle.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(io.vertx.ext.mail.MailClient delegate)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDelegate

public io.vertx.ext.mail.MailClient getDelegate()

createNonShared

@Deprecated
public static MailClient createNonShared(Vertx vertx,
                                                     io.vertx.ext.mail.MailConfig config)

Deprecated.

Parameters:

vertx -

config -

Returns:

create

public static MailClient create(Vertx vertx,
                                io.vertx.ext.mail.MailConfig config)

Create a non shared instance of the mail client.

Parameters:

vertx - the Vertx instance the operation will be run in

config - 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,
                                      io.vertx.ext.mail.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 instance

config - the configuration

poolName - the pool name

Returns:

the client

createShared

public static MailClient createShared(Vertx vertx,
                                      io.vertx.ext.mail.MailConfig config)

Like createShared(io.vertx.axle.core.Vertx, io.vertx.ext.mail.MailConfig, java.lang.String) but with the default pool name

Parameters:

vertx - the Vert.x instance

config - the configuration

Returns:

the client

sendMail

public CompletionStage<io.vertx.ext.mail.MailResult> sendMail(io.vertx.ext.mail.MailMessage email)

send a single mail via MailClient

Parameters:

email - MailMessage object containing the mail text, from/to, attachments etc

Returns:

this MailClient instance so the method can be used fluently

close

public void close()

close the MailClient

newInstance

public static MailClient newInstance(io.vertx.ext.mail.MailClient arg)