Mail.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.action.mail.internal;

import static org.apache.commons.lang.StringUtils.*;

import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.mail.DefaultAuthenticator;
import org.apache.commons.mail.Email;
import org.apache.commons.mail.EmailAttachment;
import org.apache.commons.mail.EmailException;
import org.apache.commons.mail.MultiPartEmail;
import org.apache.commons.mail.SimpleEmail;
import org.openhab.core.scriptengine.action.ActionDoc;
import org.openhab.core.scriptengine.action.ParamDoc;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class provides static methods that can be used in automation rules
 * for sending emails via SMTP.
 *
 * @author Kai Kreuzer
 * @author John Cocula
 *         added multiple attachments, set attachment name, brought up to Apache Commons Email 1.4
 * @since 0.4.0
 *
 */
public class Mail {

    private static final Logger logger = LoggerFactory.getLogger(Mail.class);

    static String hostname;
    static Integer port;
    static String username;
    static String password;
    static String from;

    static boolean startTLSEnabled;
    static boolean sslOnConnect;
    static boolean popBeforeSmtp = false;
    static String charset;

    /**
     * Sends an email via SMTP
     *
     * @param to the email address of the recipient
     * @param subject the subject of the email
     * @param message the body of the email
     *
     * @return <code>true</code>, if sending the email has been successful and
     *         <code>false</code> in all other cases.
     */
    @ActionDoc(text = "Sends an email via SMTP")
    static public boolean sendMail(@ParamDoc(name = "to") String to, @ParamDoc(name = "subject") String subject,
            @ParamDoc(name = "message") String message) {
        return sendMail(to, subject, message, (String) null);
    }

    /**
     * Sends an email with attachment via SMTP
     *
     * @param to the email address of the recipient
     * @param subject the subject of the email
     * @param message the body of the email
     * @param attachmentUrl a URL string of the content to send as an attachment
     *
     * @return <code>true</code>, if sending the email has been successful and
     *         <code>false</code> in all other cases.
     */
    @ActionDoc(text = "Sends an email with attachment via SMTP")
    static public boolean sendMail(@ParamDoc(name = "to") String to, @ParamDoc(name = "subject") String subject,
            @ParamDoc(name = "message") String message, @ParamDoc(name = "attachmentUrl") String attachmentUrl) {
        List<String> attachmentUrlList = null;
        if (isNotBlank(attachmentUrl)) {
            attachmentUrlList = new ArrayList<String>();
            attachmentUrlList.add(attachmentUrl);
        }
        return sendMail(to, subject, message, attachmentUrlList);
    }

    /**
     * Sends an email with attachment(s) via SMTP
     *
     * @param to the email address of the recipient
     * @param subject the subject of the email
     * @param message the body of the email
     * @param attachmentUrlList a list of URL strings of the contents to send as attachments
     *
     * @return <code>true</code>, if sending the email has been successful and
     *         <code>false</code> in all other cases.
     */
    @ActionDoc(text = "Sends an email with attachment via SMTP")
    static public boolean sendMail(@ParamDoc(name = "to") String to, @ParamDoc(name = "subject") String subject,
            @ParamDoc(name = "message") String message,
            @ParamDoc(name = "attachmentUrlList") List<String> attachmentUrlList) {
        boolean success = false;
        if (MailActionService.isProperlyConfigured) {
            Email email = new SimpleEmail();
            if (attachmentUrlList != null && !attachmentUrlList.isEmpty()) {
                email = new MultiPartEmail();
                for (String attachmentUrl : attachmentUrlList) {
                    // Create the attachment
                    try {
                        EmailAttachment attachment = new EmailAttachment();
                        attachment.setURL(new URL(attachmentUrl));
                        attachment.setDisposition(EmailAttachment.ATTACHMENT);
                        String fileName = attachmentUrl.replaceFirst(".*/([^/?]+).*", "$1");
                        attachment.setName(isNotBlank(fileName) ? fileName : "Attachment");
                        ((MultiPartEmail) email).attach(attachment);
                    } catch (MalformedURLException e) {
                        logger.error("Invalid attachment url.", e);
                    } catch (EmailException e) {
                        logger.error("Error adding attachment to email.", e);
                    }
                }
            }

            email.setHostName(hostname);
            email.setSmtpPort(port);
            email.setStartTLSEnabled(startTLSEnabled);
            email.setSSLOnConnect(sslOnConnect);

            if (isNotBlank(username)) {
                if (popBeforeSmtp) {
                    email.setPopBeforeSmtp(true, hostname, username, password);
                } else {
                    email.setAuthenticator(new DefaultAuthenticator(username, password));
                }
            }

            try {
                if (isNotBlank(charset)) {
                    email.setCharset(charset);
                }
                email.setFrom(from);
                String[] toList = to.split(";");
                for (String toAddress : toList) {
                    email.addTo(toAddress);
                }
                if (!isEmpty(subject)) {
                    email.setSubject(subject);
                }
                if (!isEmpty(message)) {
                    email.setMsg(message);
                }
                email.send();
                logger.debug("Sent email to '{}' with subject '{}'.", to, subject);
                success = true;
            } catch (EmailException e) {
                logger.error("Could not send e-mail to '" + to + "'.", e);
            }
        } else {
            logger.error(
                    "Cannot send e-mail because of missing configuration settings. The current settings are: "
                            + "Host: '{}', port '{}', from '{}', startTLSEnabled: {}, sslOnConnect: {}, username: '{}', password '{}'",
                    new Object[] { hostname, String.valueOf(port), from, String.valueOf(startTLSEnabled),
                            String.valueOf(sslOnConnect), username, password });
        }

        return success;
    }
}