com.irurueta.server.commons.email.ApacheMailHtmlEmailMessage.java Source code

Introduction

Here is the source code for com.irurueta.server.commons.email.ApacheMailHtmlEmailMessage.java

Source

/**
 * Copyright (C) 2016 Alberto Irurueta Carro (alberto@irurueta.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.irurueta.server.commons.email;

import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.List;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.HtmlEmail;

/**
 * Class to build emails having HTML markup as in webpages using Apache Mail.
 * These kind of emails are useful for marketing purposes or simply to get a
 * nicer layout.
 * Files can be attached as in text emails, or they can be sent inline so they
 * can be used within the html content (such as images or css resources to be
 * used within html email body).
 */
public class ApacheMailHtmlEmailMessage extends HtmlEmailMessage<HtmlEmail> {

    /**
     * Constructor.
     */
    public ApacheMailHtmlEmailMessage() {
        super();
    }

    /**
     * Constructor with email subject.
     * @param subject subject to be set.
     */
    public ApacheMailHtmlEmailMessage(String subject) {
        super(subject);
    }

    /**
     * Constructor with email subject and textual content.
     * @param subject subject to be set.
     * @param htmlContent HTML content.
     */
    public ApacheMailHtmlEmailMessage(String subject, String htmlContent) {
        super(subject, htmlContent);
    }

    /**
     * Builds email content to be sent using an email sender.
     * @param content instance where content must be set.
     * @throws com.irurueta.server.commons.email.EmailException if setting mail 
     * content fails.
     */
    @Override
    protected void buildContent(HtmlEmail content) throws com.irurueta.server.commons.email.EmailException {
        try {
            if (getAlternativeText() != null) {
                content.setTextMsg(getAlternativeText());
            }

            //process inline attachments
            boolean[] generated = processInlineAttachments();

            if (getHtmlContent() != null) {
                content.setHtmlMsg(process(getHtmlContent(), generated));
            }

            //all attachments go into general message multipar

            //add inline attachments
            List<InlineAttachment> inlineAttachments = getInlineAttachments();
            if (inlineAttachments != null) {
                for (InlineAttachment attachment : inlineAttachments) {
                    //only add attachments with files and content ids
                    if (attachment.getContentId() == null || attachment.getAttachment() == null) {
                        continue;
                    }

                    content.embed(attachment.getAttachment(), attachment.getContentId());
                }
            }

            //add other attachments parts
            List<EmailAttachment> attachments = getEmailAttachments();
            org.apache.commons.mail.EmailAttachment apacheAttachment;
            if (attachments != null) {
                for (EmailAttachment attachment : attachments) {
                    //only add attachments with files
                    if (attachment.getAttachment() == null) {
                        continue;
                    }

                    apacheAttachment = new org.apache.commons.mail.EmailAttachment();
                    apacheAttachment.setPath(attachment.getAttachment().getAbsolutePath());
                    apacheAttachment.setDisposition(org.apache.commons.mail.EmailAttachment.ATTACHMENT);
                    if (attachment.getName() != null) {
                        apacheAttachment.setName(attachment.getName());
                    }

                    content.attach(apacheAttachment);
                }
            }
        } catch (EmailException e) {
            throw new com.irurueta.server.commons.email.EmailException(e);
        }
    }

    /**
     * Reads files to be attached inline in HTML content.
     * @return array indicating for whith files content was inlined.
     */
    private boolean[] processInlineAttachments() {
        List<InlineAttachment> attachments = getInlineAttachments();
        if (attachments != null) {
            boolean[] result = new boolean[attachments.size()];
            int counter = 0;
            boolean isGeneratedId;
            String contentId;
            for (InlineAttachment attachment : attachments) {
                isGeneratedId = attachment.getContentId() == null;
                result[counter] = isGeneratedId;
                if (isGeneratedId) {
                    //generate a content id for this attachment
                    contentId = "inline-attachment" + counter;
                    attachment.setContentId(contentId);
                }
                counter++;
            }
            return result;
        }
        return null;
    }

    /**
     * Processes HTML content to substitute placeholders by their corresponding
     * //inline attachment ids.
     * @param htmlContent HTML content to be sent.
     * @param generated array containing inlined files that where found as 
     * placeholders and correctly inlined into content.
     * @return resulting content.
     */
    private String process(String htmlContent, boolean[] generated) {
        //if no information about generated inline ids is available, then simply
        //return input html content
        if (generated == null) {
            return htmlContent;
        }

        //process html content to substitute placeholders by their corresponding
        //inline attachments ids
        List<InlineAttachment> attachments = getInlineAttachments();
        List<String> contentIds = new ArrayList<>();
        int pos = 0;
        if (attachments != null) {
            for (InlineAttachment attachment : attachments) {
                if (generated[pos]) {
                    contentIds.add(attachment.getContentId());
                }
                pos++;
            }
        }

        Object[] objects = contentIds.toArray();
        return MessageFormat.format(htmlContent, objects);
    }
}