001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH (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 GmbH, 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.CmsRuntimeException;
032import org.opencms.main.OpenCms;
033import org.opencms.util.CmsStringUtil;
034
035import javax.mail.AuthenticationFailedException;
036
037import org.apache.commons.logging.Log;
038import org.apache.commons.mail.EmailException;
039import org.apache.commons.mail.SimpleEmail;
040
041/**
042 * This class is used to send simple text internet email messages without
043 * attachments.<p>
044 *
045 * It uses the Apache Commons Email API and extends the provided classes to
046 * conveniently generate emails using the OpenCms configuration.<p>
047 *
048 * @since 6.0.0
049 */
050public class CmsSimpleMail extends SimpleEmail {
051
052    /** The log object for this class. */
053    private static final Log LOG = CmsLog.getLog(CmsSimpleMail.class);
054
055    /**
056     * Default constructor of a CmsSimpleMail.<p>
057     *
058     * The mail host name and the mail from address are set to the OpenCms
059     * default values of the configuration.<p>
060     *
061     */
062    public CmsSimpleMail() {
063
064        // call super constructor
065        super();
066        // set the host to the default mail host
067        CmsMailHost host = OpenCms.getSystemInfo().getMailSettings().getDefaultMailHost();
068        setHostName(host.getHostname());
069        setSmtpPort(host.getPort());
070
071        // check if username and password are provided
072        String userName = host.getUsername();
073        if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(userName)) {
074            // authentication needed, set user name and password
075            setAuthentication(userName, host.getPassword());
076        }
077        try {
078            // set default mail from address
079            setFrom(OpenCms.getSystemInfo().getMailSettings().getMailFromDefault());
080        } catch (EmailException e) {
081            // default email address is not valid, log error
082            LOG.error(Messages.get().getBundle().key(Messages.LOG_INVALID_SENDER_ADDRESS_0), e);
083        }
084    }
085
086    /**
087     * Overrides to add a better message for authentication exception.<p>
088     *
089     * @see org.apache.commons.mail.Email#send()
090     */
091    @Override
092    public String send() {
093
094        String messageID = null;
095        try {
096            messageID = super.send();
097        } catch (EmailException e) {
098            // check if original Exception is of type SendFailedException which
099            // should have been thrown by javax.mail.Transport.send()
100            if (e.getCause() instanceof AuthenticationFailedException) {
101                CmsMailHost host = OpenCms.getSystemInfo().getMailSettings().getDefaultMailHost();
102                // wrong user credentials in opencms-system.xml: mail api does not provide a message for authentication exception
103
104                CmsRuntimeException rte = new CmsRuntimeException(
105                    Messages.get().container(
106                        Messages.ERR_SEND_EMAIL_AUTHENTICATE_2,
107                        host.getUsername(),
108                        host.getHostname()));
109                rte.initCause(e);
110                throw rte;
111
112            } else {
113                CmsRuntimeException rte = new CmsRuntimeException(
114                    Messages.get().container(Messages.ERR_SEND_EMAIL_CONFIG_0));
115                rte.initCause(e);
116                throw rte;
117            }
118        }
119        return messageID;
120    }
121}