View Javadoc

1   /**
2    * This file Copyright (c) 2003-2012 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.templates.impl;
35  
36  import info.magnolia.freemarker.FreemarkerHelper;
37  import info.magnolia.module.mail.MailTemplate;
38  import info.magnolia.module.mail.templates.MgnlMultipartEmail;
39  
40  import java.io.Reader;
41  import java.io.StringReader;
42  import java.io.StringWriter;
43  
44  import javax.mail.MessagingException;
45  
46  /**
47   * Sends an email using a freemarker template.
48   */
49  public class FreemarkerEmail extends MgnlMultipartEmail {
50  
51      public FreemarkerEmail(MailTemplate template) {
52          super(template);
53      }
54  
55      @Override
56      public void setFrom(String from) {
57          try {
58              from = processFreemarkerString(from);
59          } catch (Exception e) {
60              log.error("Couldn't set from: " + from);
61          }
62          super.setFrom(from);
63      }
64  
65      @Override
66      public void setSubject(String subject) throws MessagingException {
67          try {
68              subject = processFreemarkerString(subject);
69              super.setSubject(subject);
70          } catch (Exception e) {
71              throw new MessagingException();
72          }
73  
74      }
75  
76      @Override
77      public void setToList(String list) throws Exception {
78          list = processFreemarkerString(list);
79          super.setToList(list);
80      }
81  
82      @Override
83      public void setBody(String body) throws Exception {
84          body = processFreemarkerString(body);
85          super.setBody(body);
86      }
87  
88      @Override
89      public void setBodyFromResourceFile() throws Exception {
90          final StringWriter writer = new StringWriter();
91          FreemarkerHelper.getInstance().render(super.getTemplate().getTemplateFile(), super.getTemplate().getParameters(), writer);
92          super.setBody(writer.toString());
93      }
94  
95      /**
96       * @deprecated since 5.1. Please, use {@link #processFreemarkerString(String)} instead.
97       */
98      protected String proccesFreemarkerString(String text) throws Exception {
99          return processFreemarkerString(text);
100     }
101 
102     protected String processFreemarkerString(String text) throws Exception {
103         Reader reader = new StringReader(text);
104         final StringWriter writer = new StringWriter();
105         FreemarkerHelper.getInstance().render(reader, super.getTemplate().getParameters(), writer);
106         reader.close();
107         return writer.toString();
108     }
109 
110 }