org.intermine.util.MailUtils.java Source code

Introduction

Here is the source code for org.intermine.util.MailUtils.java

Source

package org.intermine.util;

/*
 * Copyright (C) 2002-2016 FlyMine
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public Licence.  This should
 * be distributed with the code.  See the LICENSE file for more
 * information or http://www.gnu.org/copyleft/lesser.html.
 *
 */

import java.text.MessageFormat;
import java.util.Properties;

import javax.mail.Authenticator;
import javax.mail.Message;
import javax.mail.MessagingException;
import javax.mail.PasswordAuthentication;
import javax.mail.Session;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;

import org.apache.commons.lang.StringUtils;

/**
 * Mail utilities for the webapp.
 *
 * @author Kim Rutherford
 * @author Matthew Wakeling
 */
public abstract class MailUtils {
    private MailUtils() {
        // private constructor
    }

    /**
     * Send a welcoming email to an email address
     *
     * @param to the address to send to
     * @param webProperties properties such as the from address
     * @throws MessagingException if there is a problem creating the email
     */
    public static void welcome(String to, final Properties webProperties) throws MessagingException {
        String subject = webProperties.getProperty("mail.subject");
        String text = webProperties.getProperty("mail.text");
        email(to, subject, text, webProperties);
    }

    /**
     * Send an email to an address, supplying the recipient, subject and body.
     *
     * @param to the address to send to
     * @param subject The Subject of the email
     * @param body The content of the email
     * @param from the address to send from
     * @param webProperties Common properties for all emails (such as from, authentication)
     * @throws MessagingException if there is a problem creating the email
     */
    public static void email(String to, String subject, String body, String from, final Properties webProperties)
            throws MessagingException {
        final String user = webProperties.getProperty("mail.smtp.user");
        String smtpPort = webProperties.getProperty("mail.smtp.port");
        String authFlag = webProperties.getProperty("mail.smtp.auth");
        String starttlsFlag = webProperties.getProperty("mail.smtp.starttls.enable");

        Properties properties = System.getProperties();

        properties.put("mail.smtp.host", webProperties.get("mail.host"));
        properties.put("mail.smtp.user", user);
        // Fix to "javax.mail.MessagingException: 501 Syntactically
        // invalid HELO argument(s)" problem
        // See http://forum.java.sun.com/thread.jspa?threadID=487000&messageID=2280968
        properties.put("mail.smtp.localhost", "localhost");
        if (smtpPort != null) {
            properties.put("mail.smtp.port", smtpPort);
        }
        if (starttlsFlag != null) {
            properties.put("mail.smtp.starttls.enable", starttlsFlag);
        }
        if (authFlag != null) {
            properties.put("mail.smtp.auth", authFlag);
        }

        Session session;
        if (authFlag != null && ("true".equals(authFlag) || "t".equals(authFlag))) {
            Authenticator authenticator = new Authenticator() {
                @Override
                protected PasswordAuthentication getPasswordAuthentication() {
                    String password = (String) webProperties.get("mail.server.password");
                    return new PasswordAuthentication(user, password);
                }
            };
            session = Session.getInstance(properties, authenticator);
        } else {
            session = Session.getInstance(properties);
        }
        MimeMessage message = new MimeMessage(session);
        if (StringUtils.isEmpty(user)) {
            message.setFrom(new InternetAddress(from));
        } else {
            message.setReplyTo(InternetAddress.parse(from, true));
            message.setFrom(new InternetAddress(user));
        }
        message.addRecipient(Message.RecipientType.TO, InternetAddress.parse(to, true)[0]);
        message.setSubject(subject);
        message.setContent(body, "text/plain");
        Transport.send(message);
    }

    /**
     * @param to the address to send to
     * @param subject The Subject of the email
     * @param body The content of the email
     * @param webProperties Common properties for all emails (such as from, authentication)
     * @throws MessagingException if there is a problem creating the email
     */
    public static void email(String to, String subject, String body, final Properties webProperties)
            throws MessagingException {
        String from = (String) webProperties.get("mail.from");
        email(to, subject, body, from, webProperties);
    }

    /**
     * Send a password change email to an email address
     *
     * @param to the address to send to
     * @param url the URL to embed in the email
     * @param webProperties properties such as the from address
     * @throws Exception if there is a problem creating the email
     */
    public static void emailPasswordToken(String to, String url, final Properties webProperties) throws Exception {

        String projectTitle = (String) webProperties.get("project.title");
        String baseSubject = (String) webProperties.get("mail.passwordSubject");
        String mailSubject = MessageFormat.format(baseSubject, new Object[] { projectTitle });
        String mailText = (String) webProperties.get("mail.passwordText");
        String mailTextWithUrl = MessageFormat.format(mailText, new Object[] { url });
        email(to, mailSubject, mailTextWithUrl, webProperties);
    }

    /**
     * Subscribe the given email address to the mailing list specified in the
     * mine config file
     * @param email the email to subscribe
     * @param webProperties the web properties
     * @throws MessagingException when something goes wrong
     */
    public static void subscribe(String email, final Properties webProperties) throws MessagingException {
        String to = (String) webProperties.get("mail.mailing-list");
        String subject = "";
        String body = "";
        email(to, subject, body, email, webProperties);
    }
}