sirius.web.mails

Class Mails

java.lang.Object

sirius.web.mails.Mails

All Implemented Interfaces:

sirius.kernel.health.metrics.MetricProvider

public class Mails
extends Object
implements sirius.kernel.health.metrics.MetricProvider

Used to send mails using predefined templates.

Field Summary

Fields

Modifier and Type	Field and Description
static sirius.kernel.health.Log	LOG Contains the logger mail used by the mailing framework.
static String	X_BOUNCETOKEN Defines a header which can be used to add a bounce token to an email.

Constructor Summary

Constructors

Constructor and Description
Mails()

Method Summary

Modifier and Type	Method and Description
MailSender	createEmail() Creates a new builder which is used to specify the mail to send.
void	failForInvalidEmail(String address, String name) Determines if the given email address and the optional name is valid.
void	gather(sirius.kernel.health.metrics.MetricsCollector collector)
boolean	isValidMailAddress(String address, String name) Determines if the given address is a valid eMail address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final sirius.kernel.health.Log LOG

Contains the logger mail used by the mailing framework.

X_BOUNCETOKEN

public static final String X_BOUNCETOKEN

Defines a header which can be used to add a bounce token to an email.

This token can be extracted from received bounce mails and handled properly.

See Also:

Constant Field Values

Constructor Detail

Mails

public Mails()

Method Detail

gather

public void gather(sirius.kernel.health.metrics.MetricsCollector collector)

Specified by:

gather in interface sirius.kernel.health.metrics.MetricProvider

createEmail

public MailSender createEmail()

Creates a new builder which is used to specify the mail to send.

Returns:

a new builder used to create an email.

isValidMailAddress

public boolean isValidMailAddress(@Nullable
                                  String address,
                                  @Nullable
                                  String name)

Determines if the given address is a valid eMail address.

The name is optional and can be left empty. If address is null or empty, false will be returned.

Parameters:

address - the email address to check

name - the optional name to also check

Returns:

true if the given address is valid, false otherwise

failForInvalidEmail

public void failForInvalidEmail(@Nullable
                                String address,
                                @Nullable
                                String name)

Determines if the given email address and the optional name is valid. Throws a HandledException otherwise.

Parameters:

address - the email address to validate

name - the optional name to validate - can be left empty or null