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 GmbH & Co. KG, 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.CmsRuntimeException;
031import org.opencms.main.OpenCms;
032
033import javax.mail.AuthenticationFailedException;
034
035import org.apache.commons.mail.EmailException;
036import org.apache.commons.mail.SimpleEmail;
037
038/**
039 * This class is used to send simple text internet email messages without
040 * attachments.<p>
041 *
042 * It uses the Apache Commons Email API and extends the provided classes to
043 * conveniently generate emails using the OpenCms configuration.<p>
044 *
045 * @since 6.0.0
046 */
047public class CmsSimpleMail extends SimpleEmail {
048
049    /**
050     * Default constructor of a CmsSimpleMail.<p>
051     *
052     * The mail host name and the mail from address are set to the OpenCms
053     * default values of the configuration.<p>
054     *
055     */
056    public CmsSimpleMail() {
057
058        this(OpenCms.getSystemInfo().getMailSettings().getDefaultMailHost());
059    }
060
061    /**
062     * Constructor of a CmsSimpleMail where the mail host is explicitly chosen.<p>
063     *
064     * The mail from address is set to the OpenCms
065     * default values of the configuration.<p>
066     *
067     * @param mailHost the mail host to use (a host configured in OpenCms).
068     */
069    public CmsSimpleMail(CmsMailHost mailHost) {
070
071        // call super constructor
072        super();
073        CmsMailUtil.configureMail(mailHost, this);
074    }
075
076    /**
077     * Overrides to add a better message for authentication exception.<p>
078     *
079     * @see org.apache.commons.mail.Email#send()
080     */
081    @Override
082    public String send() {
083
084        String messageID = null;
085        try {
086            messageID = super.send();
087        } catch (EmailException e) {
088            // check if original Exception is of type SendFailedException which
089            // should have been thrown by javax.mail.Transport.send()
090            if (e.getCause() instanceof AuthenticationFailedException) {
091                CmsMailHost host = OpenCms.getSystemInfo().getMailSettings().getDefaultMailHost();
092                // wrong user credentials in opencms-system.xml: mail api does not provide a message for authentication exception
093
094                CmsRuntimeException rte = new CmsRuntimeException(
095                    Messages.get().container(
096                        Messages.ERR_SEND_EMAIL_AUTHENTICATE_2,
097                        host.getUsername(),
098                        host.getHostname()));
099                rte.initCause(e);
100                throw rte;
101
102            } else {
103                CmsRuntimeException rte = new CmsRuntimeException(
104                    Messages.get().container(Messages.ERR_SEND_EMAIL_CONFIG_0));
105                rte.initCause(e);
106                throw rte;
107            }
108        }
109        return messageID;
110    }
111}