01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/newsletter/I_CmsNewsletter.java,v $
03: * Date : $Date: 2008-02-27 12:05:33 $
04: * Version: $Revision: 1.4 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
10: *
11: * This library is free software; you can redistribute it and/or
12: * modify it under the terms of the GNU Lesser General Public
13: * License as published by the Free Software Foundation; either
14: * version 2.1 of the License, or (at your option) any later version.
15: *
16: * This library is distributed in the hope that it will be useful,
17: * but WITHOUT ANY WARRANTY; without even the implied warranty of
18: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19: * Lesser General Public License for more details.
20: *
21: * For further information about Alkacon Software GmbH, please see the
22: * company website: http://www.alkacon.com
23: *
24: * For further information about OpenCms, please see the
25: * project website: http://www.opencms.org
26: *
27: * You should have received a copy of the GNU Lesser General Public
28: * License along with this library; if not, write to the Free Software
29: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30: */
31:
32: package org.opencms.newsletter;
33:
34: import org.opencms.file.CmsObject;
35: import org.opencms.file.CmsResource;
36: import org.opencms.main.CmsException;
37:
38: import javax.mail.MessagingException;
39:
40: import org.apache.commons.mail.Email;
41:
42: /**
43: * Interface for the newsletter.<p>
44: */
45: public interface I_CmsNewsletter {
46:
47: /** Macro for the date. */
48: String MACRO_SEND_DATE = "date";
49:
50: /** Macro for the email address. */
51: String MACRO_USER_EMAIL = "email";
52:
53: /** Macro for the firstname. */
54: String MACRO_USER_FIRSTNAME = "firstname";
55:
56: /** Macro for the full name. */
57: String MACRO_USER_FULLNAME = "fullname";
58:
59: /** Macro for the lastname. */
60: String MACRO_USER_LASTNAME = "lastname";
61:
62: /**
63: * Adds a OpenCms resource as an attachment to the newsletter.<p>
64: *
65: * @param cms the CmsObject
66: * @param resource the resource to attach
67: *
68: * @throws CmsException if something goes wrong
69: */
70: void addAttachment(CmsObject cms, CmsResource resource)
71: throws CmsException;
72:
73: /**
74: * Adds content to the newsletter.<p>
75: *
76: * @param content the content to add
77: */
78: void addContent(I_CmsNewsletterContent content);
79:
80: /**
81: * Returns the newsletter as an e-mail to be sent.<p>
82: *
83: * @param cms the CmsObject
84: * @param recipient the recipient to which the newsletter will be sent
85: * @return the newsletter as an e-mail
86: * @throws MessagingException if something goes wrong
87: * @throws CmsException if something goes wrong
88: */
89: Email getEmail(CmsObject cms, I_CmsNewsletterRecipient recipient)
90: throws MessagingException, CmsException;
91:
92: /**
93: * Sets the subject.<p>
94: *
95: * @param subject the subject to set
96: */
97: void setSubject(String subject);
98: }
|