com.communote.server.core.mail.messages.user

Class NotifyAboutNoteMailMessage

java.lang.Object

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

com.communote.server.core.mail.messages.user.NotifyAboutNoteMailMessage

public class NotifyAboutNoteMailMessage
extends MailMessage

Notification message for notifying about created/modified note.

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
NotifyAboutNoteMailMessage(User recipient, User sender, Locale locale, Note note, Blog blog, Map<String,String> templatePlaceholderMessageKeys, Map<String,Object> model) Create a notification message for user a note.

Method Summary

Modifier and Type	Method and Description
String	getMessageIdentifier() Returns an identifier of the message which can be used in the Message-ID header.
String	getReplyToAddress() Returns a string holding the email address to be used in the "reply-to" header.
String	getReplyToAddressName() Returns the personal name to be used in the "reply-to" header field.
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, 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

NotifyAboutNoteMailMessage

public NotifyAboutNoteMailMessage(User recipient,
                                  User sender,
                                  Locale locale,
                                  Note note,
                                  Blog blog,
                                  Map<String,String> templatePlaceholderMessageKeys,
                                  Map<String,Object> model)

Create a notification message for user a note.

Parameters:

recipient - the user to notify about the note

note - the user tagged post

blog - the associated topic/blog

sender - the sender

locale - the locale

templatePlaceholderMessageKeys - A map of placeholders to message keys, which will be replaced within the template with the loaded message. Use it in the template @@placeholderMessageKey@@.

model - Additional elements used for the velocity context.

Method Detail

getMessageIdentifier

public String getMessageIdentifier()

Description copied from class: MailMessage

Returns an identifier of the message which can be used in the Message-ID header. The identifier must be unique and must fulfill the dot-atom-text pattern of rfc2822. The identifier will extended to become a syntactically correct Message-ID header field value.

Overrides:

getMessageIdentifier in class MailMessage

Returns:

the message identifier or null if no specific Message-ID header should be set

getReplyToAddress

public String getReplyToAddress()

Description copied from class: MailMessage

Returns a string holding the email address to be used in the "reply-to" header. The default implementation returns an address defined for the current client. If null is returned, the "reply-to" header should not be set.

Overrides:

getReplyToAddress in class MailMessage

Returns:

the email address to add to the reply-to header, can be null

getReplyToAddressName

public String getReplyToAddressName()

Description copied from class: MailMessage

Returns the personal name to be used in the "reply-to" header field.

Overrides:

getReplyToAddressName in class MailMessage

Returns:

the personal name

prepareModel

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

Description copied from class: MailMessage

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().