com.communote.server.core.mail.messages

Class SecurityCodeMailMessage

java.lang.Object

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

com.communote.server.core.mail.messages.SecurityCodeMailMessage

Direct Known Subclasses:

ConfirmEmailAddressMessage, ConfirmUserMailMessage, ForgottenPWMailMessage, InviteUserToBlogMailMessage, InviteUserToClientMailMessage, InviteUserToClientWithExternalAuthMailMessage, RemindUserRegistrationMailMessage, UserLockedMailMessage

public class SecurityCodeMailMessage
extends MailMessage

Mail which contains a link with a SecurityCode to confirm some action.

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
SecurityCodeMailMessage(String messageKey, Locale locale, User... recipients) Construct a new message with the given message key and locale.

Method Summary

Modifier and Type	Method and Description
String	getLinkParamAction() Get the name of the request parameter which should be set to the action of the SecurityCode.
String	getLinkParamCode() Get the name of the request parameter which should be set to the actual code of the SecurityCode.
String	getLinkPrefix() Gets the link prefix.
String	getSecurityCodeConfirmationLink(SecurityCode securityCode) Get the link for confirmation of the security code.
String	getSecurityCodeConfirmationLink(SecurityCode securityCode, String query)
void	prepareModel(Map<String,Object> model) Does nothing.

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

SecurityCodeMailMessage

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

Construct a new message with the given message key and locale.

Parameters:

messageKey - Key of the message template.

locale - the locale to use

recipients - recipients of the mail

Method Detail

getLinkParamAction

public String getLinkParamAction()

Get the name of the request parameter which should be set to the action of the SecurityCode.

Returns:

the parameter name

getLinkParamCode

public String getLinkParamCode()

Get the name of the request parameter which should be set to the actual code of the SecurityCode.

Returns:

the parameter name

getLinkPrefix

public String getLinkPrefix()

Gets the link prefix.

Returns:

the link prefix

getSecurityCodeConfirmationLink

public String getSecurityCodeConfirmationLink(SecurityCode securityCode)

Get the link for confirmation of the security code.

Parameters:

securityCode - the security code

Returns:

the link

getSecurityCodeConfirmationLink

public String getSecurityCodeConfirmationLink(SecurityCode securityCode,
                                              String query)

Parameters:

securityCode - the security code

query - some addtional parameters to be append to the url

Returns:

the final absolute url for confirmation

prepareModel

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

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