001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.mail;
029
030import org.opencms.main.CmsLog;
031import org.opencms.main.OpenCms;
032import org.opencms.util.CmsStringUtil;
033
034import org.apache.commons.logging.Log;
035import org.apache.commons.mail.Email;
036import org.apache.commons.mail.EmailException;
037
038/**
039 * Contains utility methods for dealing with emails.<p>
040 */
041public final class CmsMailUtil {
042
043    /** The logger instance for this class. */
044    private static final Log LOG = CmsLog.getLog(CmsMailUtil.class);
045
046    /** Value for 'security' attribute to enable SSL. */
047    public static final String SECURITY_SSL = "SSL";
048
049    /** Value for 'security' attribute to enable TLS. */
050    public static final String SECURITY_STARTTLS = "STARTTLS";
051
052    /**
053     * Hidden default constructor.<p>
054     */
055    private CmsMailUtil() {
056
057        // hidden default constructor
058    }
059
060    /**
061     * Configures the mail from the given mail host configuration data.<p>
062     *
063     * @param host the mail host configuration
064     * @param mail the email instance
065     */
066    public static void configureMail(CmsMailHost host, Email mail) {
067
068        // set the host to the default mail host
069        mail.setHostName(host.getHostname());
070        mail.setSmtpPort(host.getPort());
071
072        // check if username and password are provided
073        String userName = host.getUsername();
074        if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(userName)) {
075            // authentication needed, set user name and password
076            mail.setAuthentication(userName, host.getPassword());
077        }
078        String security = host.getSecurity() != null ? host.getSecurity().trim() : null;
079        if (SECURITY_SSL.equalsIgnoreCase(security)) {
080            mail.setSslSmtpPort("" + host.getPort());
081            mail.setSSLOnConnect(true);
082        } else if (SECURITY_STARTTLS.equalsIgnoreCase(security)) {
083            mail.setStartTLSEnabled(true);
084        }
085
086        try {
087            // set default mail from address
088            String mailFrom = host.getMailfrom() != null
089            ? host.getMailfrom()
090            : OpenCms.getSystemInfo().getMailSettings().getMailFromDefault();
091            mail.setFrom(mailFrom);
092        } catch (EmailException e) {
093            // default email address is not valid, log error
094            LOG.error(Messages.get().getBundle().key(Messages.LOG_INVALID_SENDER_ADDRESS_0), e);
095        }
096    }
097}