org.hawkular.commons.email

Interface EmailDispatcher

All Known Implementing Classes:

EmailDispatcherImpl

public interface EmailDispatcher

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
boolean	dispatch(javax.mail.internet.InternetAddress recipient, String subject, String templatePlain, String templateHtml, Map<String,Object> properties) Dispatches an email message to the given recipient, with the subject.

Method Detail

dispatch

boolean dispatch(javax.mail.internet.InternetAddress recipient,
                 String subject,
                 String templatePlain,
                 String templateHtml,
                 Map<String,Object> properties)

Dispatches an email message to the given recipient, with the subject. The template parameters and the properties are for the Freemarker formatting, and should follow its standards. For instance, if templatePlain is 'invitation_plain.ftl' then 'invitation_plain.ftl' would be loaded from one of the template repositories (or invitation_plain_$LOCALE.ftl, according to the Freemarker rules of template loading). The properties map is a set of properties to be merged with the templates.

Parameters:

recipient - the recipient of the message

subject - the subject of the message, already localized

templatePlain - the template to use for plain text

templateHtml - the template to use for HTML message

properties - the properties to merge with the template

Returns:

a boolean indicating whether the message was dispatched