com.communote.server.core.mail.messages

Class GenericMailMessage

java.lang.Object

com.communote.server.core.mail.messages.MailMessage

com.communote.server.core.mail.messages.GenericMailMessage

public class GenericMailMessage
extends MailMessage

General purpose mail message.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields inherited from class com.communote.server.core.mail.messages.MailMessage

ACTIVATION_LINK_PREFIX

Constructor Summary

Constructors

Constructor and Description
GenericMailMessage(String messageKey, Locale locale, Map<String,Object> model, User... recipients) Constructor.
GenericMailMessage(String messageKey, Locale locale, User... recipients) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addToModel(String key, Object value) Adds the element to the mail model.
void	prepareModel(Map<String,Object> model) Prepare a model of key-value pairs which will be passed to the template engine when the content and subject templates should be rendered.

Methods inherited from class com.communote.server.core.mail.messages.MailMessage

addBcc, addCc, addTo, addTo, addTo, getBcc, getCc, getContentTemplate, getContentTemplateId, getFromAddress, getFromAddressName, getGlobalModel, getLocale, getMessageIdentifier, getReplyToAddress, getReplyToAddressName, getSubjectTemplate, getSubjectTemplateId, getTo, getToAddresses, getToAddressPersonalName, isHtmlMail, isInsertRecipientPersonalName, setFromAddress, setFromAddressName, setInsertRecipientPersonalName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenericMailMessage

public GenericMailMessage(String messageKey,
                          Locale locale,
                          User... recipients)

Constructor.

Parameters:

messageKey - The message key of the template.

recipients - users to send the message to

locale - The locale.

GenericMailMessage

public GenericMailMessage(String messageKey,
                          Locale locale,
                          Map<String,Object> model,
                          User... recipients)

Constructor.

Parameters:

messageKey - The message key of the template.

recipients - users to send the message to

locale - The locale for sending the message

model - Model with key value pairs which should be available when rendering the template.

Method Detail

addToModel

public void addToModel(String key,
                       Object value)

Adds the element to the mail model.

Parameters:

key - The key.

value - The value.

prepareModel

public void prepareModel(Map<String,Object> model)

Prepare a model of key-value pairs which will be passed to the template engine when the content and subject templates should be rendered.

Specified by:

prepareModel in class MailMessage

Parameters:

model - The model to prepare. It will be initialized with the settings returned by MailMessage.getGlobalModel().