com.communote.server.core.mail.messages

Class MailMessage

java.lang.Object

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

Direct Known Subclasses:

ActivateUserForManagerMailMessage, ActivateUserMailMessage, BlogNameIdMissingInSubjectMailMessage, BlogsNotFoundMailMessage, ContentProcessingErrorMailMessage, DirectMessageMissingRecipientMailMessage, GenericErrorMailMessage, GenericMailMessage, ManagerSecurityWarnMailMessage, NewUserConfirmedForManagerMessage, NoteLimitReachedMailMessage, NotifyAboutCRCSizeLimitReachedMailMessage, NotifyAboutNoteMailMessage, NotifyUserCountLimitReachedMailMessage, NoWriteAccessToBlogMailMessage, RemindUserLoginMailMessage, SecurityCodeMailMessage, TextMailMessage, UserNotInClientMailMessage, WarningMailMessage

public abstract class MailMessage
extends Object

An abstract base class for all mail messages. Subclasses can define templates for the content and subject of the mail and can provide data to be available when the templates are rendered.

Author:

Communote team - http://communote.github.io/

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVATION_LINK_PREFIX Holds the relative path to the user management section of administration area

Constructor Summary

Constructors

Constructor and Description
MailMessage(String messageKey, Locale locale, Collection<User> recipients) Construct a new message.
MailMessage(String messageKey, Locale locale, User... recipients) Construct a new message.
MailMessage(String messageKey, Map<String,String> templatePlaceholderMessageKeys, Locale locale, Collection<User> recipients) Construct a new message.
MailMessage(String messageKey, Map<String,String> templatePlaceholderMessageKeys, Locale locale, User... recipients) Construct a new message.

Method Summary

Modifier and Type	Method and Description
void	addBcc(User user) Add a recipient of the email.
void	addCc(User user) Add a recipient of the email.
void	addTo(String emailAddress) Add a recipient of the email.
void	addTo(String emailAddress, String personalName) Add a recipient of the email.
void	addTo(User user) Add a recipient of the email.
Collection<User>	getBcc()
Collection<User>	getCc()
String	getContentTemplate()
String	getContentTemplateId()
String	getFromAddress() Get the email address of the sender. If no address has been set the configured address of the Communote installation will be returned.
String	getFromAddressName() Get the personal name of the sender.
Map<String,Object>	getGlobalModel() Model of key-value pairs with common data useful for all mail messages.
Locale	getLocale()
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.
String	getSubjectTemplate()
String	getSubjectTemplateId()
Collection<User>	getTo()
Collection<String>	getToAddresses()
String	getToAddressPersonalName(String emailAddress) Return a personal name which was added with an email address by invoking addTo(String, String).
boolean	isHtmlMail() States whether the underlying mail content template produces an HTML mail or not.
boolean	isInsertRecipientPersonalName()
abstract 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.
void	setFromAddress(String fromAddress) Set the email address of sender. Note: be careful when setting an address because the domain part of the address should normally not leave the domain of the outgoing email server.
void	setFromAddressName(String fromAddressName) Set the personal name of the sender.
void	setInsertRecipientPersonalName(boolean insertRecipientPersonalName) Define whether the personal name (first name, last name and salutation if available) of a recipient should be added to the TO, CC or BCC headers.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVATION_LINK_PREFIX

public static final String ACTIVATION_LINK_PREFIX

Holds the relative path to the user management section of administration area

See Also:

Constant Field Values

Constructor Detail

MailMessage

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

Construct a new message. Content and subject templates will be retrieved from the ResourceBundleManager.

Parameters:

messageKey - Key of the message to get from the ResourceBundleManager and use as content template. The key will be returned by getContentTemplateId(). The key of the message to use as the subject template is derived from the messageKey by appending .subject to it.

locale - the locale to use when getting the templates from the ResourceBundleManager

recipients - A list of recipients of this message. The email addresses will be added to the TO header.

MailMessage

public MailMessage(String messageKey,
                   Locale locale,
                   Collection<User> recipients)

Construct a new message. Content and subject templates will be retrieved from the ResourceBundleManager.

Parameters:

messageKey - Key of the message to get from the ResourceBundleManager and use as content template. The key will be returned by getContentTemplateId(). The key of the message to use as the subject template is derived from the messageKey by appending .subject to it.

locale - the locale to use when getting the templates from the ResourceBundleManager

recipients - A list of recipients of this message. The email addresses will be added to the TO header.

MailMessage

public MailMessage(String messageKey,
                   Map<String,String> templatePlaceholderMessageKeys,
                   Locale locale,
                   User... recipients)

Construct a new message. Content and subject templates will be retrieved from the ResourceBundleManager.

Parameters:

messageKey - Key of the message to get from the ResourceBundleManager and use as content template. The key will be returned by getContentTemplateId(). The key of the message to use as the subject template is derived from the messageKey by appending .subject to it.

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

locale - the locale to use when getting the templates from the ResourceBundleManager

recipients - A list of recipients of this message. The email addresses will be added to the TO header.

Since:

3.5

MailMessage

public MailMessage(String messageKey,
                   Map<String,String> templatePlaceholderMessageKeys,
                   Locale locale,
                   Collection<User> recipients)

Construct a new message. Content and subject templates will be retrieved from the ResourceBundleManager.

Parameters:

messageKey - Key of the message to get from the ResourceBundleManager and use as content template. The key will be returned by getContentTemplateId(). The key of the message to use as the subject template is derived from the messageKey by appending .subject to it.

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

locale - the locale to use when getting the templates from the ResourceBundleManager

recipients - A list of recipients of this message. The email addresses will be added to the TO header.

Since:

3.5

Method Detail

addBcc

public void addBcc(User user)

Add a recipient of the email. The email address of the user will be added to the BCC header.

Parameters:

user - the user to send the mail to

Since:

3.5

addCc

public void addCc(User user)

Add a recipient of the email. The email address of the user will be added to the CC header.

Parameters:

user - the user to send the mail to

Since:

3.5

addTo

public void addTo(User user)

Add a recipient of the email. The email address of the user will be added to the TO header.

Parameters:

user - the user to send the mail to

Since:

3.5

addTo

public void addTo(String emailAddress)

Add a recipient of the email. The email address will be added to the TO header.

Parameters:

emailAddress - the email address of the recipient

Since:

3.5

addTo

public void addTo(String emailAddress,
                  String personalName)

Add a recipient of the email. The email address will be added to the TO header.

Parameters:

emailAddress - the email address of the recipient

personalName - the personal name to add to the TO header.

Since:

3.5

getBcc

public Collection<User> getBcc()

Returns:

a possibly empty collection of all users whose email addresses should be added to the BCC header

Since:

3.5

getCc

public Collection<User> getCc()

Returns:

a possibly empty collection of all users whose email addresses should be added to the CC header

Since:

3.5

getContentTemplate

public String getContentTemplate()

Returns:

the template for rendering the content of the mail message

Since:

3.5

getContentTemplateId

public String getContentTemplateId()

Returns:

an ID of the content template

Since:

3.5

getFromAddress

public String getFromAddress()

Get the email address of the sender.
If no address has been set the configured address of the Communote installation will be returned.

Returns:

the email address to be used in the From header

getFromAddressName

public String getFromAddressName()

Get the personal name of the sender.
If no name has been set the configured name of the Communote installation will be returned.

Returns:

the sender name to be used in the From header

getGlobalModel

public Map<String,Object> getGlobalModel()

Model of key-value pairs with common data useful for all mail messages. The model will be passed to prepareModel(Map) where it can be extended with specific data before handing it over to the template rendering engine.

Returns:

the model

getLocale

public Locale getLocale()

Returns:

the locale

getMessageIdentifier

public String getMessageIdentifier()

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.

Returns:

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

getReplyToAddress

public String getReplyToAddress()

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.

Returns:

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

getReplyToAddressName

public String getReplyToAddressName()

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

Returns:

the personal name

getSubjectTemplate

public String getSubjectTemplate()

Returns:

the template for rendering the subject of the mail message

Since:

3.5

getSubjectTemplateId

public String getSubjectTemplateId()

Returns:

an ID of the subject template

Since:

3.5

getTo

public Collection<User> getTo()

Returns:

a possibly empty collection of all users whose email addresses should be added to the TO header

Since:

3.5

getToAddresses

public Collection<String> getToAddresses()

Returns:

a possibly empty collection of email addresses which should be added to the TO header. This doesn't include the email addresses of the users returned by getTo(), instead only the addresses added with addTo(String) or addTo(String, String) are returned.

Since:

3.5

getToAddressPersonalName

public String getToAddressPersonalName(String emailAddress)

Return a personal name which was added with an email address by invoking addTo(String, String).

Parameters:

emailAddress - the email address for which the personal name should be returned

Returns:

the personal name added with the email address or null if no personal name was added or the email address wasn't added

Since:

3.5

isHtmlMail

public boolean isHtmlMail()

States whether the underlying mail content template produces an HTML mail or not.

Returns:

True if the mail template produces HTML

isInsertRecipientPersonalName

public boolean isInsertRecipientPersonalName()

Returns:

whether to insert the personal name (first name, last name and salutation if available) of a recipient to the TO, CC or BCC header. By default the personal name is not added.

Since:

3.5

prepareModel

public abstract 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.

Parameters:

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

setFromAddress

public void setFromAddress(String fromAddress)

Set the email address of sender.
Note: be careful when setting an address because the domain part of the address should normally not leave the domain of the outgoing email server.

Parameters:

fromAddress - the email address to be used in From header

Since:

3.5

setFromAddressName

public void setFromAddressName(String fromAddressName)

Set the personal name of the sender.

Parameters:

fromAddressName - the name of the sender to be used in the From header

Since:

3.5

setInsertRecipientPersonalName

public void setInsertRecipientPersonalName(boolean insertRecipientPersonalName)

Define whether the personal name (first name, last name and salutation if available) of a recipient should be added to the TO, CC or BCC headers.

Parameters:

insertRecipientPersonalName - true to insert the personal name, false otherwise

Since:

3.5