1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.notifications.notifiers.email

File NotificationEmailRenderer.java

 

Code metrics

0
0
0
1
61
11
0
-
-
0
-

Classes

Class Line # Actions
NotificationEmailRenderer 33 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.notifications.notifiers.email;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.notifications.CompositeEvent;
24    import org.xwiki.notifications.NotificationException;
25   
26    /**
27    * Render a notification for email sendings.
28    *
29    * @version $Id: 9b0fbb81ba1a3267e3f39c4af7758a51cca0e2c4 $
30    * @since 9.5RC1
31    */
32    @Role
 
33    public interface NotificationEmailRenderer
34    {
35    /**
36    * @param compositeEvent the event to render
37    * @param userId id of the user who will receive the email
38    * @return the HTML rendered version of the event
39    * @throws NotificationException of error occurs
40    * @since 9.10RC1
41    */
42    String renderHTML(CompositeEvent compositeEvent, String userId) throws NotificationException;
43   
44    /**
45    * @param compositeEvent the event to render
46    * @param userId id of the user who will receive the email
47    * @return the plain text rendered version of the event
48    * @throws NotificationException of error occurs
49    * @since 9.10RC1
50    */
51    String renderPlainText(CompositeEvent compositeEvent, String userId) throws NotificationException;
52   
53    /**
54    * @param compositeEvent the event to render
55    * @param userId id of the user who will receive the email
56    * @return the plain text subject for the email
57    * @throws NotificationException of error occurs
58    * @since 9.10RC1
59    */
60    String generateEmailSubject(CompositeEvent compositeEvent, String userId) throws NotificationException;
61    }