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.OpenCms;
031
032import org.apache.commons.mail.HtmlEmail;
033
034/**
035 * This class is used to send an HTML formatted email with optional attachments.<p>
036 *
037 * A text message can also be set for HTML unaware email clients,
038 * such as text-based email clients.<p>
039 *
040 * It uses the Apache Commons Email API and extends the provided classes
041 * to conveniently generate emails using the OpenCms configuration.<p>
042 *
043 * @since 6.0.0
044 */
045public class CmsHtmlMail extends HtmlEmail {
046
047    /**
048     * Default constructor of a CmsHtmlMail.<p>
049     *
050     * The mail host name and the mail from address are set to the OpenCms
051     * default values of the configuration.<p>
052     *
053     */
054    public CmsHtmlMail() {
055
056        this(OpenCms.getSystemInfo().getMailSettings().getDefaultMailHost());
057    }
058
059    /**
060     * Constructor of a CmsHtmlMail where the mail host is explicitly chosen.<p>
061     *
062     * The mail from address is set to the OpenCms
063     * default values of the configuration.<p>
064     *
065     * @param mailHost the mail host to use (a host configured in OpenCms).
066     *
067     */
068    public CmsHtmlMail(CmsMailHost mailHost) {
069
070        // call super constructor
071        super();
072        CmsMailUtil.configureMail(mailHost, this);
073    }
074
075    /**
076     * Constructor of a CmsHtmlMail where the id of the mail host is explicitly chosen.<p>
077     *
078     * If the mail host with the chosen id is not available, fall back to the default mail host.
079     *
080     * @param mailHostId the mail host id
081     */
082    public CmsHtmlMail(String mailHostId) {
083
084        super();
085        CmsMailSettings mailSettings = OpenCms.getSystemInfo().getMailSettings();
086        CmsMailHost mailHost = mailSettings.getMailHost(mailHostId);
087        CmsMailHost defaultMailHost = mailSettings.getDefaultMailHost();
088        CmsMailUtil.configureMail(mailHost != null ? mailHost : defaultMailHost, this);
089    }
090}