sirius.web.mails

Class MailSender

java.lang.Object

sirius.web.mails.MailSender

public class MailSender
extends Object

Implements the builder pattern to specify the mail to send.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<DataSource>	attachments
protected String	bounceToken
protected static String	CONFIG_KEY_HEADERS
protected Map<String,String>	headers
protected String	html
protected sirius.kernel.commons.Context	htmlContext
protected String	htmlTemplate
protected String	lang
protected String	receiverEmail
protected String	receiverName
protected String	senderEmail
protected String	senderName
protected boolean	simulate
protected String	subject
protected String	text
protected sirius.kernel.commons.Context	textContext
protected String	textTemplate
protected String	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MailSender()

Method Summary

Modifier and Type	Method and Description
MailSender	addAttachment(DataSource attachment) Adds an attachment to the email.
MailSender	addAttachments(DataSource... attachmentsToAdd) Adds an array of attachments to the email.
MailSender	addAttachments(List<DataSource> attachments) Adds a list of attachments to the email.
MailSender	addHeader(String name, String value) Adds an individual header to the SMTP message.
String	addResourceAsAttachment(String resource, String filename) Adds a resource as attachment.
MailSender	addResourceAsAttachment(String resource, String filename, String contentId) Adds a resource as attachment.
MailSender	from(String senderEmail, String senderName) Specifies both, the sender email and name.
MailSender	fromEmail(String senderEmail) Sets the email address used as sender of the email.
MailSender	fromName(String senderName) Sets the name used as sender of the mail.
MailSender	htmlContent(String html) Sets the HTML content of the email.
MailSender	htmlTemplate(String template, sirius.kernel.commons.Context context) Renders the given template and uses it as HTML part.
void	send() Sends the mail using the given settings.
protected void	sendMailAsync(SMTPConfiguration config)
MailSender	setBounceToken(String token) Sets a bounce token.
MailSender	setLang(String... langs) Sets the language used to perform NLS lookups when rendering templates.
MailSender	simulate(boolean simulateOnly) Sets the simulation flag.
MailSender	subject(String subject) Specifies the subject line of the mail.
MailSender	textContent(String text) Sets the text content of the email.
MailSender	textTemplate(String template, sirius.kernel.commons.Context context) Renders the given template and uses it as text part.
MailSender	to(String receiverEmail, String receiverName) Specifies both, the receiver email and name.
MailSender	toEmail(String receiverEmail) Specifies the email address to send the mail to.
MailSender	toName(String receiverName) Specifies the name of the receiver.
MailSender	type(String type) Specifies the type of the mail primarily used for logging.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY_HEADERS

protected static final String CONFIG_KEY_HEADERS

See Also:

Constant Field Values

simulate

protected boolean simulate

senderEmail

protected String senderEmail

senderName

protected String senderName

receiverEmail

protected String receiverEmail

receiverName

protected String receiverName

subject

protected String subject

textContext

protected sirius.kernel.commons.Context textContext

htmlContext

protected sirius.kernel.commons.Context htmlContext

textTemplate

protected String textTemplate

htmlTemplate

protected String htmlTemplate

text

protected String text

html

protected String html

type

protected String type

attachments

protected List<DataSource> attachments

bounceToken

protected String bounceToken

lang

protected String lang

headers

protected Map<String,String> headers

Constructor Detail

MailSender

protected MailSender()

Method Detail

fromEmail

public MailSender fromEmail(String senderEmail)

Sets the email address used as sender of the email.

Parameters:

senderEmail - the address used as sender of the email.

Returns:

the builder itself

fromName

public MailSender fromName(String senderName)

Sets the name used as sender of the mail.

Parameters:

senderName - the senders name of the email

Returns:

the builder itself

toEmail

public MailSender toEmail(String receiverEmail)

Specifies the email address to send the mail to.

Parameters:

receiverEmail - the target address of the email

Returns:

the builder itself

toName

public MailSender toName(String receiverName)

Specifies the name of the receiver.

Parameters:

receiverName - the name of the receiver

Returns:

the builder itself

from

public MailSender from(String senderEmail,
                       String senderName)

Specifies both, the sender email and name.

This is boilerpalte for fromEmail(senderEmail).fromName(senderName)

Parameters:

senderEmail - the email address which sent the email

senderName - the name of the sender of the email

Returns:

the buidler itself

to

public MailSender to(String receiverEmail,
                     String receiverName)

Specifies both, the receiver email and name.

This is boilerpalte for toEmail(receiverEmail).toName(receiverName)

Parameters:

receiverEmail - the email address which should receive the email

receiverName - the name of the receiver of the email

Returns:

the buidler itself

subject

public MailSender subject(String subject)

Specifies the subject line of the mail.

Parameters:

subject - the subject line to use.

Returns:

the builder itself

type

public MailSender type(String type)

Specifies the type of the mail primarily used for logging.

Parameters:

type - the type to use.

Returns:

the builder itself

addHeader

public MailSender addHeader(String name,
                            String value)

Adds an individual header to the SMTP message.

Parameters:

name - the name of the header to add

value - the value of the header to add

Returns:

the builder itself

textContent

public MailSender textContent(String text)

Sets the text content of the email.

Parameters:

text - the text content of the email

Returns:

the builder itself

textTemplate

public MailSender textTemplate(String template,
                               @Nonnull
                               sirius.kernel.commons.Context context)

Renders the given template and uses it as text part.

Parameters:

template - the name of the template to render

context - the context passed to the renderer

Returns:

the builder itself

htmlContent

public MailSender htmlContent(String html)

Sets the HTML content of the email.

Parameters:

html - the HTML content of the email

Returns:

the builder itself

htmlTemplate

public MailSender htmlTemplate(String template,
                               @Nonnull
                               sirius.kernel.commons.Context context)

Renders the given template and uses it as HTML part.

Parameters:

template - the name of the template to render

context - the context passed to the renderer

Returns:

the builder itself

addAttachment

public MailSender addAttachment(DataSource attachment)

Adds an attachment to the email.

Use Generator.generateAttachment(String) to directly generate an attachment from a template.

Parameters:

attachment - the attachment to add to the email

Returns:

the builder itself

addResourceAsAttachment

public MailSender addResourceAsAttachment(@Nonnull
                                          String resource,
                                          @Nullable
                                          String filename,
                                          @Nullable
                                          String contentId)

Adds a resource as attachment.

This only adds a static file as attachment. Use addAttachment(DataSource) and Generator.generateAttachment(String) to evaluate a template.

Parameters:

resource - the resource to lookup using Resources.resolve(String)

filename - the filename to use for the attachment

contentId - the content id to reference it within HTML content. < and > are automatically added. Note that most mail clients like to see a valid message id (xxx@domain.tld) here.

Returns:

the builder itself

addResourceAsAttachment

public String addResourceAsAttachment(@Nonnull
                                      String resource,
                                      @Nullable
                                      String filename)

Adds a resource as attachment.

This can be called from within a template to reference the template directly.

Parameters:

resource - the resource to lookup using Resources.resolve(String)

filename - the filename to use for the attachment

Returns:

the content id to reference it within HTML content. < and > are automatically added.

See Also:

addResourceAsAttachment(String, String, String)

addAttachments

public MailSender addAttachments(DataSource... attachmentsToAdd)

Adds an array of attachments to the email.

Parameters:

attachmentsToAdd - the attachments to add

Returns:

the builder itself

addAttachments

public MailSender addAttachments(List<DataSource> attachments)

Adds a list of attachments to the email.

Parameters:

attachments - the attachments to add

Returns:

the builder itself

setBounceToken

public MailSender setBounceToken(String token)

Sets a bounce token.

This bounce toke is hopefully included in a bounce email (generated if a mail cannot be delivered). This permits better bounce handling.

Parameters:

token - the token to identify the mail by a bounde handler.

Returns:

the builder itself

simulate

public MailSender simulate(boolean simulateOnly)

Sets the simulation flag.

A mail which is simulated (simulateOnly is true) will occur in the mail logs etc. but won't actually be sent.

Parameters:

simulateOnly - true if the mail should just be simulated but not actually be sent.

Returns:

the builder itself

setLang

public MailSender setLang(String... langs)

Sets the language used to perform NLS lookups when rendering templates.

Parameters:

langs - an array of languages. The first non empty value is used.

Returns:

the builder itself

send

public void send()

Sends the mail using the given settings.

Once all settings are validated, the mail is send in a separate thread so this method will return rather quickly. Note that a HandledException is thrown in case of invalid settings (bad mail address etc.).

sendMailAsync

protected void sendMailAsync(SMTPConfiguration config)