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.newsletter;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.main.CmsException;
033
034import javax.mail.MessagingException;
035
036import org.apache.commons.mail.Email;
037
038/**
039 * Interface for the newsletter.<p>
040 */
041public interface I_CmsNewsletter {
042
043    /** Macro for the date. */
044    String MACRO_SEND_DATE = "date";
045
046    /** Macro for the email address. */
047    String MACRO_USER_EMAIL = "email";
048
049    /** Macro for the firstname. */
050    String MACRO_USER_FIRSTNAME = "firstname";
051
052    /** Macro for the full name. */
053    String MACRO_USER_FULLNAME = "fullname";
054
055    /** Macro for the lastname. */
056    String MACRO_USER_LASTNAME = "lastname";
057
058    /**
059     * Adds a OpenCms resource as an attachment to the newsletter.<p>
060     *
061     * @param cms the CmsObject
062     * @param resource the resource to attach
063     *
064     * @throws CmsException if something goes wrong
065     */
066    void addAttachment(CmsObject cms, CmsResource resource) throws CmsException;
067
068    /**
069     * Adds content to the newsletter.<p>
070     *
071     * @param content the content to add
072     */
073    void addContent(I_CmsNewsletterContent content);
074
075    /**
076     * Returns the newsletter as an e-mail to be sent.<p>
077     *
078     * @param cms the CmsObject
079     * @param recipient the recipient to which the newsletter will be sent
080     * @return the newsletter as an e-mail
081     * @throws MessagingException if something goes wrong
082     * @throws CmsException if something goes wrong
083     */
084    Email getEmail(CmsObject cms, I_CmsNewsletterRecipient recipient) throws MessagingException, CmsException;
085
086    /**
087     * Sets the subject.<p>
088     *
089     * @param subject the subject to set
090     */
091    void setSubject(String subject);
092}