org.xwiki.notifications.notifiers.email

Interface NotificationEmailRenderer

@Role
public interface NotificationEmailRenderer

Render a notification for email sendings.

Since:

9.5RC1

Version:

$Id: 9b0fbb81ba1a3267e3f39c4af7758a51cca0e2c4 $

Method Summary

Modifier and Type	Method and Description
String	generateEmailSubject(CompositeEvent compositeEvent, String userId)
String	renderHTML(CompositeEvent compositeEvent, String userId)
String	renderPlainText(CompositeEvent compositeEvent, String userId)

Method Detail

renderHTML

String renderHTML(CompositeEvent compositeEvent,
                  String userId)
           throws NotificationException

Parameters:

compositeEvent - the event to render

userId - id of the user who will receive the email

Returns:

the HTML rendered version of the event

Throws:

NotificationException - of error occurs

Since:

9.10RC1

renderPlainText

String renderPlainText(CompositeEvent compositeEvent,
                       String userId)
                throws NotificationException

Parameters:

compositeEvent - the event to render

userId - id of the user who will receive the email

Returns:

the plain text rendered version of the event

Throws:

NotificationException - of error occurs

Since:

9.10RC1

generateEmailSubject

String generateEmailSubject(CompositeEvent compositeEvent,
                            String userId)
                     throws NotificationException

Parameters:

compositeEvent - the event to render

userId - id of the user who will receive the email

Returns:

the plain text subject for the email

Throws:

NotificationException - of error occurs

Since:

9.10RC1