1 /**
2 * This file Copyright (c) 2003-2010 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.mail.handlers;
35
36 import info.magnolia.module.mail.templates.MgnlEmail;
37
38
39 /**
40 * The interface to implement for sending emails with Magnolia.
41 * Date: Mar 30, 2006 Time: 1:06:23 PM
42 * @author <a href="mailto:niko@macnica.com">Nicolas Modrzyk</a>
43 * @see SimpleMailHandler
44 * @see ThreadedMailHandler
45 */
46 public interface MgnlMailHandler {
47
48 /**
49 * Prepare the email (format it) and send it.
50 * @param email the email to send
51 * @throws Exception if fails
52 */
53 void prepareAndSendMail(MgnlEmail email) throws Exception;
54
55 /**
56 * Send the email as is, without touching it.
57 * @param email the email to send
58 * @throws Exception if fails
59 */
60 void sendMail(MgnlEmail email) throws Exception;
61
62 }