TextMimeBodyPartFactory.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.mail.internal.factory.text;

import java.nio.charset.StandardCharsets;
import java.util.Map;

import javax.inject.Inject;
import javax.inject.Singleton;
import javax.mail.MessagingException;
import javax.mail.internet.MimeBodyPart;

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.xwiki.component.annotation.Component;
import org.xwiki.mail.internal.factory.AbstractMimeBodyPartFactory;

/**
 * Creates text message body Part to be added to a Multi Part message.
 *
 * @version $Id: 1f8d8a93d5b240f1e127e60a7bdfbf6b036d4d0d $
 * @since 6.1M2
 */
@Component
@Singleton
public class TextMimeBodyPartFactory extends AbstractMimeBodyPartFactory<String>
{
    private static final String TEXT_PLAIN_CONTENT_TYPE = "text/plain; charset=" + StandardCharsets.UTF_8.name();

    /**
     * Provides access to the logger.
     */
    @Inject
    private Logger logger;

    @Override
    public MimeBodyPart create(String content, Map<String, Object> parameters) throws MessagingException
    {
        // Create the body part of the email
        MimeBodyPart bodyPart = new MimeBodyPart();

        bodyPart.setContent(content, TEXT_PLAIN_CONTENT_TYPE);

        bodyPart.setHeader("Content-Type", getMimetype(parameters));

        // Handle headers passed as parameter
        addHeaders(bodyPart, parameters);

        return bodyPart;
    }

    /**
     * Extracts the mime type from the passed parameters Map.
     *
     * @param parameters the parameters from which to extract the mime type if defined
     * @return either the extracted mimetype or {@code text/plain} if not the property is not passed in the parameters
     */
    protected String getMimetype(Map<String, Object> parameters)
    {
        String mimeType = (String) parameters.get("mimetype");
        if (StringUtils.isEmpty(mimeType)) {
            mimeType = TEXT_PLAIN_CONTENT_TYPE;
        }
        return mimeType;
    }
}