Package 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 ofEmailFactory
.- Author:
- avasquez
-
-
Field Summary
Fields Modifier and Type Field 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
protected String
templatePrefix
protected String
templateSuffix
-
Constructor Summary
Constructors Constructor Description EmailFactoryImpl()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected javax.mail.internet.MimeMessage
createMessage(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject, String body, boolean html, File... attachments)
Email
getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String body, boolean html, File... attachments)
Creates a newEmail
.Email
getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String templateName, Object templateModel, boolean html, File... attachments)
Creates a newEmail
.Email
getEmail(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject, String body, boolean html, File... attachments)
Creates a newEmail
.Email
getEmail(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject, String templateName, Object templateModel, boolean html, File... attachments)
Creates a newEmail
.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)
void
setTemplatePrefix(String templatePrefix)
void
setTemplateSuffix(String templateSuffix)
-
-
-
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
-
templatePrefix
protected String templatePrefix
-
templateSuffix
protected String templateSuffix
-
templateEncoding
protected String templateEncoding
-
-
Method Detail
-
setMailSender
public void setMailSender(org.springframework.mail.javamail.JavaMailSender mailSender)
-
setFreeMarkerConfig
public void setFreeMarkerConfig(freemarker.template.Configuration freeMarkerConfig)
-
setTemplatePrefix
public void setTemplatePrefix(String templatePrefix)
-
setTemplateSuffix
public void setTemplateSuffix(String templateSuffix)
-
setTemplateEncoding
public void setTemplateEncoding(String templateEncoding)
-
getEmail
public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String body, boolean html, File... attachments) throws EmailException
Description copied from interface:EmailFactory
Creates a newEmail
.- Specified by:
getEmail
in interfaceEmailFactory
- Parameters:
from
- the sender's addressto
- the recipients' addresses (optional)cc
- the CC recipients' addresses (optional)bcc
- the BCC recipients' addresses (optional)subject
- the subject of the emailbody
- the text body of the emailhtml
- if the body is in HTML formatattachments
- the attachments to add to the email- Returns:
- the created email
- Throws:
EmailException
-
getEmail
public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject, String body, boolean html, File... attachments) throws EmailException
Description copied from interface:EmailFactory
Creates a newEmail
.- Specified by:
getEmail
in interfaceEmailFactory
- Parameters:
from
- the sender's addressto
- the recipients' addresses (optional)cc
- the CC recipients' addresses (optional)bcc
- the BCC recipients' addresses (optional)replyTo
- the address to reply tosubject
- the subject of the emailbody
- the text body of the emailhtml
- 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, File... attachments) throws EmailException
Description copied from interface:EmailFactory
Creates a newEmail
.- Specified by:
getEmail
in interfaceEmailFactory
- Parameters:
from
- the sender's addressto
- the recipients' addresses (optional)cc
- the CC recipients' addresses (optional)bcc
- the BCC recipients' addresses (optional)subject
- the subject of the emailtemplateName
- the template name of the emailtemplateModel
- the template model of the emailhtml
- 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 replyTo, String subject, String templateName, Object templateModel, boolean html, File... attachments) throws EmailException
Description copied from interface:EmailFactory
Creates a newEmail
.- Specified by:
getEmail
in interfaceEmailFactory
- Parameters:
from
- the sender's addressto
- the recipients' addresses (optional)cc
- the CC recipients' addresses (optional)bcc
- the BCC recipients' addresses (optional)replyTo
- the address to reply tosubject
- the subject of the emailtemplateName
- the template name of the emailtemplateModel
- the template model of the emailhtml
- 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 replyTo, String subject, String body, boolean html, File... attachments) throws EmailException
- Throws:
EmailException
-
processTemplate
protected String processTemplate(String templateName, Object templateModel) throws EmailException
- Throws:
EmailException
-
-