org.craftercms.commons.mail.impl.EmailFactoryImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of crafter-commons-utilities Show documentation
Crafter Commons Utilities
There is a newer version: 4.1.8
Show newest version
/*
 * Copyright (C) 2007-2014 Crafter Software Corporation.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.craftercms.commons.mail.impl;

import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import javax.mail.MessagingException;
import javax.mail.internet.AddressException;
import javax.mail.internet.MimeMessage;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import org.apache.commons.lang3.ArrayUtils;
import org.apache.commons.lang3.StringUtils;
import org.craftercms.commons.i10n.I10nLogger;
import org.craftercms.commons.i10n.I10nUtils;
import org.craftercms.commons.mail.Email;
import org.craftercms.commons.mail.EmailAddressException;
import org.craftercms.commons.mail.EmailException;
import org.craftercms.commons.mail.EmailFactory;
import org.craftercms.commons.mail.EmailPreparationException;
import org.springframework.beans.factory.annotation.Required;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;

/**
 * Default implementation of {@link org.craftercms.commons.mail.EmailFactory}.
 *
 * @author avasquez
 */
public class EmailFactoryImpl implements EmailFactory {

    public static final String DEFAULT_ENCODING = "UTF-8";
    public static final String LOG_KEY_MIME_MSG_CREATED = "mail.mimeMessageCreated";
    public static final String LOG_KEY_PROCESSING_EMAIL_TEMPLATE = "mail.processingEmailTemplate";
    public static final String ERROR_KEY_TEMPLATE_CONFIG_MISSING = "mail.templateConfigMissing";

    private static final I10nLogger logger = new I10nLogger(EmailFactoryImpl.class, I10nUtils.DEFAULT_LOGGING_MESSAGE_BUNDLE_NAME);

    protected JavaMailSender mailSender;
    protected Configuration freeMarkerConfig;
    protected String templatePrefix;
    protected String templateSuffix;
    protected String templateEncoding;

    public EmailFactoryImpl() {
        templatePrefix = "";
        templateSuffix = "";
        templateEncoding = DEFAULT_ENCODING;
    }

    @Required
    public void setMailSender(JavaMailSender mailSender) {
        this.mailSender = mailSender;
    }

    public void setFreeMarkerConfig(Configuration freeMarkerConfig) {
        this.freeMarkerConfig = freeMarkerConfig;
    }

    public void setTemplatePrefix(String templatePrefix) {
        this.templatePrefix = templatePrefix;
    }

    public void setTemplateSuffix(String templateSuffix) {
        this.templateSuffix = templateSuffix;
    }

    public void setTemplateEncoding(String templateEncoding) {
        this.templateEncoding = templateEncoding;
    }

    @Override
    public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String body,
                          boolean html, File... attachments) throws EmailException {
        return getEmail(from, to, cc, bcc, null, subject, body, html, attachments);
    }

    @Override
    public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String replyTo, String subject,
                          String body, boolean html, File... attachments) throws EmailException {
        MimeMessage message = createMessage(from, to, cc, bcc, replyTo, subject, body, html, attachments);
        Email email = new EmailImpl(mailSender, message);

        return email;
    }

    @Override
    public Email getEmail(String from, String[] to, String[] cc, String[] bcc, String subject, String templateName,
                          Object templateModel, boolean html, File... attachments) throws EmailException {
        return getEmail(from, to, cc, bcc, null, subject, templateName, templateModel, html, attachments);
    }

    @Override
    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 {
        return getEmail(from, to, cc, bcc, replyTo, subject, processTemplate(templateName, templateModel), html, attachments);
    }

    protected MimeMessage createMessage(String from, String[] to, String[] cc, String[] bcc, String replyTo,
                                        String subject, String body, boolean html, File... attachments) throws EmailException {
        boolean addAttachments = ArrayUtils.isNotEmpty(attachments);
        MimeMessageHelper messageHelper;

        try {
            if (addAttachments) {
                messageHelper = new MimeMessageHelper(mailSender.createMimeMessage(), true);
            } else {
                messageHelper = new MimeMessageHelper(mailSender.createMimeMessage());
            }

            messageHelper.setFrom(from);
            if (to != null) {
                messageHelper.setTo(to);
            }
            if (cc != null) {
                messageHelper.setCc(cc);
            }
            if (bcc != null) {
                messageHelper.setBcc(bcc);
            }
            if (replyTo != null) {
                messageHelper.setReplyTo(replyTo);
            }
            messageHelper.setSubject(subject);
            messageHelper.setText(body, html);

            if (addAttachments) {
                for (File attachment : attachments) {
                    messageHelper.addAttachment(attachment.getName(), attachment);
                }
            }
        } catch (AddressException e) {
            throw new EmailAddressException(e);
        } catch (MessagingException e) {
            throw new EmailPreparationException(e);
        }

        logger.debug(LOG_KEY_MIME_MSG_CREATED, from, StringUtils.join(to, ','), StringUtils.join(cc, ','),
                     StringUtils.join(bcc, ','), subject, body);

        return messageHelper.getMimeMessage();
    }

    protected String processTemplate(String templateName, Object templateModel) throws EmailException {
        if (freeMarkerConfig == null) {
            throw new EmailException(ERROR_KEY_TEMPLATE_CONFIG_MISSING);
        }

        templateName = templatePrefix + templateName + templateSuffix;

        logger.debug(LOG_KEY_PROCESSING_EMAIL_TEMPLATE, templateName);

        try {
            Template template = freeMarkerConfig.getTemplate(templateName, templateEncoding);
            StringWriter out = new StringWriter();

            template.process(templateModel, out);

            return out.toString();
        } catch (IOException | TemplateException e) {
            throw new EmailPreparationException(e);
        }
    }

}