org.craftercms.commons.mail.impl

Class EmailFactoryImpl

java.lang.Object

org.craftercms.commons.mail.impl.EmailFactoryImpl

All Implemented Interfaces:

EmailFactory

public class EmailFactoryImpl
extends Object
implements EmailFactory

Default implementation of EmailFactory.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENCODING
static String	ERROR_KEY_TEMPLATE_CONFIG_MISSING
protected freemarker.template.Configuration	freeMarkerConfig
static String	LOG_KEY_MIME_MSG_CREATED
static String	LOG_KEY_PROCESSING_EMAIL_TEMPLATE
protected org.springframework.mail.javamail.JavaMailSender	mailSender
protected String	templateEncoding

Constructor Summary

Constructors

Constructor and Description
EmailFactoryImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.mail.internet.MimeMessage	createMessage(String from, String[] to, String[] cc, String[] bcc, String subject, String body, boolean html)
Email	getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String body, boolean html) Creates a new Email.
Email	getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String templateName, Object templateModel, boolean html) Creates a new Email.
protected String	processTemplate(String templateName, Object templateModel)
void	setFreeMarkerConfig(freemarker.template.Configuration freeMarkerConfig)
void	setMailSender(org.springframework.mail.javamail.JavaMailSender mailSender)
void	setTemplateEncoding(String templateEncoding)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:

Constant Field Values

LOG_KEY_MIME_MSG_CREATED

public static final String LOG_KEY_MIME_MSG_CREATED

See Also:

Constant Field Values

LOG_KEY_PROCESSING_EMAIL_TEMPLATE

public static final String LOG_KEY_PROCESSING_EMAIL_TEMPLATE

See Also:

Constant Field Values

ERROR_KEY_TEMPLATE_CONFIG_MISSING

public static final String ERROR_KEY_TEMPLATE_CONFIG_MISSING

See Also:

Constant Field Values

mailSender

protected org.springframework.mail.javamail.JavaMailSender mailSender

freeMarkerConfig

protected freemarker.template.Configuration freeMarkerConfig

templateEncoding

protected String templateEncoding

Constructor Detail

EmailFactoryImpl

public EmailFactoryImpl()

Method Detail

setMailSender

public void setMailSender(org.springframework.mail.javamail.JavaMailSender mailSender)

setFreeMarkerConfig

public void setFreeMarkerConfig(freemarker.template.Configuration freeMarkerConfig)

setTemplateEncoding

public void setTemplateEncoding(String templateEncoding)

getEmail

public Email getEmail(String from,
             String[] to,
             String[] cc,
             String[] bcc,
             String subject,
             String body,
             boolean html)
               throws EmailException

Description copied from interface: EmailFactory

Creates a new Email.

Specified by:

getEmail in interface EmailFactory

Parameters:

from - the sender's address

to - the recipients' addresses (optional)

cc - the CC recipients' addresses (optional)

bcc - the BCC recipients' addresses (optional)

subject - the subject of the email

body - the text body of the email

html - if the body is in HTML format

Returns:

the created email

Throws:

EmailException

getEmail

public Email getEmail(String from,
             String[] to,
             String[] cc,
             String[] bcc,
             String subject,
             String templateName,
             Object templateModel,
             boolean html)
               throws EmailException

Description copied from interface: EmailFactory

Creates a new Email.

Specified by:

getEmail in interface EmailFactory

Parameters:

from - the sender's address

to - the recipients' addresses (optional)

cc - the CC recipients' addresses (optional)

bcc - the BCC recipients' addresses (optional)

subject - the subject of the email

templateName - the template name of the email

templateModel - the template model of the email

html - if the body is in HTML format

Returns:

the created email

Throws:

EmailException

createMessage

protected javax.mail.internet.MimeMessage createMessage(String from,
                                            String[] to,
                                            String[] cc,
                                            String[] bcc,
                                            String subject,
                                            String body,
                                            boolean html)
                                                 throws EmailException

Throws:

EmailException

processTemplate

protected String processTemplate(String templateName,
                     Object templateModel)
                          throws EmailException

Throws:

EmailException