Package org.craftercms.commons.notification.impl

Class EmailSender

java.lang.Object

org.craftercms.commons.notification.NotificationSender<EmailSender.EmailMessage>

org.craftercms.commons.notification.impl.EmailSender

All Implemented Interfaces:

AutoCloseable

public class EmailSender
extends NotificationSender<EmailSender.EmailMessage>

NotificationSender implementation that sends an email notification. The output file is attached if it's available. An EmailSender instance can be configured (see init(org.apache.commons.configuration2.Configuration)) with the following Configuration properties:

• from: The value of the From field in the emails.
• to: The value of the To field in the emails.
• subject: The value of the Subject field in the emails.
• html: Whether the emails are HTML.

See also NotificationSender for the common properties available to all notification senders.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	EmailSender.EmailMessage	NotificationSender<EmailSender.EmailMessage>.NotificationMessage extension that includes a file attachment.

Nested classes/interfaces inherited from class org.craftercms.commons.notification.NotificationSender

NotificationSender.NotificationMessage

Field Summary

Fields

Modifier and Type	Field	Description
protected final EmailFactory	emailFactory
protected String	from
static final String	FROM_CONFIG_KEY
protected boolean	html
static final String	HTML_CONFIG_KEY
static final String	OUTPUT_ATTACHED_MODEL_KEY
protected String	subject
static final String	SUBJECT_CONFIG_KEY
protected String[]	to
static final String	TO_CONFIG_KEY

Fields inherited from class org.craftercms.commons.notification.NotificationSender

DATETIME_FORMATTER_MODEL_KEY, DATETIME_PATTERN_CONFIG_KEY, dateTimeFormatter, DURATION_FORMATTER_MODEL_KEY, DURATION_PATTERN_CONFIG_KEY, durationFormatter, freeMarkerConfig, objectMapper, PAYLOAD_MODEL_KEY, templateEncoding, templatePrefix, templateSuffix

Constructor Summary

Constructors

Constructor	Description
EmailSender(freemarker.template.Configuration freeMarkerConfig, com.fasterxml.jackson.databind.ObjectMapper objectMapper, String dateTimePattern, String durationPattern, EmailFactory emailFactory, String from, String subject, boolean html)

Method Summary

Modifier and Type	Method	Description
protected EmailSender.EmailMessage	doCreateMessage(String templateName, Object payload)	Creates the notification message to send.
protected void	doNotify(EmailSender.EmailMessage message)	Sends the notification message.
void	init(org.apache.commons.configuration2.Configuration config)
void	setFrom(String from)
void	setTo(String[] to)

Methods inherited from class org.craftercms.commons.notification.NotificationSender

close, createMessage, initProperties, processTemplate, sendMessage, setTemplateEncoding, setTemplatePrefix, setTemplateSuffix

Methods inherited from class java.lang.Object

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

Field Details

FROM_CONFIG_KEY

public static final String FROM_CONFIG_KEY

See Also:

• Constant Field Values

TO_CONFIG_KEY

public static final String TO_CONFIG_KEY

See Also:

• Constant Field Values

SUBJECT_CONFIG_KEY

public static final String SUBJECT_CONFIG_KEY

See Also:

• Constant Field Values

HTML_CONFIG_KEY

public static final String HTML_CONFIG_KEY

See Also:

• Constant Field Values

OUTPUT_ATTACHED_MODEL_KEY

public static final String OUTPUT_ATTACHED_MODEL_KEY

See Also:

• Constant Field Values

emailFactory

protected final EmailFactory emailFactory

from

protected String from

to

protected String[] to

subject

protected String subject

html

protected boolean html

Constructor Details

EmailSender

@ConstructorProperties({"freeMarkerConfig","objectMapper","dateTimePattern","durationPattern","emailFactory","from","subject","html"})
public EmailSender(freemarker.template.Configuration freeMarkerConfig,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 String dateTimePattern,
 String durationPattern,
 EmailFactory emailFactory,
 String from,
 String subject,
 boolean html)

Method Details

init

public void init(org.apache.commons.configuration2.Configuration config)
          throws ConfigurationException

Overrides:

init in class NotificationSender<EmailSender.EmailMessage>

Throws:

ConfigurationException

doNotify

protected void doNotify(EmailSender.EmailMessage message)
                 throws NotificationException

Description copied from class: NotificationSender

Sends the notification message.

Specified by:

doNotify in class NotificationSender<EmailSender.EmailMessage>

Parameters:

message - the notification message

Throws:

NotificationException - if an error occurs while sending the notification

doCreateMessage

protected EmailSender.EmailMessage doCreateMessage(String templateName,
 Object payload)

Description copied from class: NotificationSender

Creates the notification message to send.

Specified by:

doCreateMessage in class NotificationSender<EmailSender.EmailMessage>

Parameters:

templateName - the name of the template to use for the notification

payload - the payload to include in the notification

Returns:

the notification message

setFrom

public void setFrom(String from)

setTo

public void setTo(String[] to)