org.alfresco.repo.action.executer

Class MailActionExecuter

java.lang.Object

org.alfresco.repo.action.CommonResourceAbstractBase

org.alfresco.repo.action.ParameterizedItemAbstractBase

org.alfresco.repo.action.executer.ActionExecuterAbstractBase

org.alfresco.repo.action.executer.MailActionExecuter

All Implemented Interfaces:

ActionExecuter, LoggingAwareExecuter, TestModeable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class MailActionExecuter
extends ActionExecuterAbstractBase
implements org.springframework.beans.factory.InitializingBean, TestModeable

Mail action executor implementation.

Note on executing this action as System: it is allowed to execute mail actions as system. However there is a limitation if you do so. Because the system user is not a normal user and specifically because there is no corresponding cm:person node for system, it is not possible to use any reference to that person in the associated email template. Various email templates use a 'person' object in the FTL model to access things like first name, last name etc. In the case of mail actions sent while running as system, none of these will be available.

Author:

Roy Wetherall

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MailActionExecuter.URLHelper

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Action executor constants
static String	PARAM_BCC
static String	PARAM_CC
static String	PARAM_FROM
static String	PARAM_FROM_PERSONAL_NAME
static String	PARAM_HTML
static String	PARAM_IGNORE_SEND_FAILURE
static String	PARAM_LOCALE
static String	PARAM_SEND_AFTER_COMMIT
static String	PARAM_SUBJECT
static String	PARAM_SUBJECT_PARAMS
static String	PARAM_TEMPLATE
static String	PARAM_TEMPLATE_MODEL
static String	PARAM_TEXT
static String	PARAM_TO
static String	PARAM_TO_MANY

Fields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

actionDefinition, applicableTypes, publicAction

Fields inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

adhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionService

Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

name

Fields inherited from interface org.alfresco.repo.action.executer.ActionExecuter

PARAM_RESULT

Constructor Summary

Constructors

Constructor and Description
MailActionExecuter()

Method Summary

Modifier and Type	Method and Description
protected void	addParameterDefinitions(List<ParameterDefinition> paramList) Add the parameter definitions
void	afterPropertiesSet() Initialise bean
void	clearLastTestMessage() Used when test mode is enabled.
protected void	executeImpl(Action ruleAction, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef) Send an email message
int	getNumberFailedSends()
int	getNumberSuccessfulSends()
org.alfresco.service.cmr.repository.NodeRef	getPerson(String user)
String	getPersonEmail(String user)
String	getTestMessageTo()
int	getTestSentCount()
void	init() Init method
boolean	isFromEnabled()
static boolean	isHTML(String value)
boolean	isTestMode()
protected void	onFail()
protected void	onSend()
boolean	personExists(String user)
org.springframework.mail.javamail.MimeMessageHelper	prepareEmail(Action ruleAction, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, org.alfresco.util.Pair<String,Locale> recipient, org.alfresco.util.Pair<InternetAddress,Locale> sender)
int	resetTestSentCount()
MimeMessage	retrieveLastTestMessage() Returns the most recent message that wasn't sent because TestMode had been enabled.
boolean	sendTestMessage() Send a test message
void	setAuthenticationService(AuthenticationService authService)
void	setAuthorityService(AuthorityService authorityService)
void	setFromAddress(String fromAddress)
void	setFromEnabled(boolean fromEnabled)
void	setHeaderEncoding(String headerEncoding)
void	setImageResolver(TemplateImageResolver imageResolver)
void	setMailService(org.springframework.mail.javamail.JavaMailSender javaMailSender)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPersonService(PersonService personService)
void	setPreferenceService(PreferenceService preferenceService)
void	setSendTestMessage(boolean sendTestMessage)
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setSysAdminParams(SysAdminParams sysAdminParams)
void	setTemplateService(TemplateService templateService)
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
void	setTestMessageSubject(String testMessageSubject)
void	setTestMessageText(String testMessageText)
void	setTestMessageTo(String testMessageTo)
void	setTestMode(boolean testMode)
void	setTestModeRecipient(String testModeRecipient)
void	setValidateAddresses(boolean validateAddresses)

Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

createActionDefinition, execute, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, isApplicableType, onLogException, setApplicableTypes, setBaseNodeService, setDictionaryService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus

Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

checkMandatoryProperties, getAdhocPropertiesAllowed, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toString

Methods inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

setBeanName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Action executor constants

See Also:

Constant Field Values

PARAM_LOCALE

public static final String PARAM_LOCALE

See Also:

Constant Field Values

PARAM_TO

public static final String PARAM_TO

See Also:

Constant Field Values

PARAM_CC

public static final String PARAM_CC

See Also:

Constant Field Values

PARAM_BCC

public static final String PARAM_BCC

See Also:

Constant Field Values

PARAM_TO_MANY

public static final String PARAM_TO_MANY

See Also:

Constant Field Values

PARAM_SUBJECT

public static final String PARAM_SUBJECT

See Also:

Constant Field Values

PARAM_SUBJECT_PARAMS

public static final String PARAM_SUBJECT_PARAMS

See Also:

Constant Field Values

PARAM_TEXT

public static final String PARAM_TEXT

See Also:

Constant Field Values

PARAM_HTML

public static final String PARAM_HTML

See Also:

Constant Field Values

PARAM_FROM

public static final String PARAM_FROM

See Also:

Constant Field Values

PARAM_FROM_PERSONAL_NAME

public static final String PARAM_FROM_PERSONAL_NAME

See Also:

Constant Field Values

PARAM_TEMPLATE

public static final String PARAM_TEMPLATE

See Also:

Constant Field Values

PARAM_TEMPLATE_MODEL

public static final String PARAM_TEMPLATE_MODEL

See Also:

Constant Field Values

PARAM_IGNORE_SEND_FAILURE

public static final String PARAM_IGNORE_SEND_FAILURE

See Also:

Constant Field Values

PARAM_SEND_AFTER_COMMIT

public static final String PARAM_SEND_AFTER_COMMIT

See Also:

Constant Field Values

Constructor Detail

MailActionExecuter

public MailActionExecuter()

Method Detail

setMailService

public void setMailService(org.springframework.mail.javamail.JavaMailSender javaMailSender)

Parameters:

javaMailSender - the java mail sender

setTemplateService

public void setTemplateService(TemplateService templateService)

Parameters:

templateService - the TemplateService

setPersonService

public void setPersonService(PersonService personService)

Parameters:

personService - the PersonService

setPreferenceService

public void setPreferenceService(PreferenceService preferenceService)

setAuthenticationService

public void setAuthenticationService(AuthenticationService authService)

Parameters:

authService - the AuthenticationService

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Parameters:

serviceRegistry - the ServiceRegistry

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Parameters:

authorityService - the AuthorityService

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Parameters:

nodeService - the NodeService to set.

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

Parameters:

tenantService - the TenantService to set.

setHeaderEncoding

public void setHeaderEncoding(String headerEncoding)

Parameters:

headerEncoding - The mail header encoding to set.

setFromAddress

public void setFromAddress(String fromAddress)

Parameters:

fromAddress - The default mail address.

setSysAdminParams

public void setSysAdminParams(SysAdminParams sysAdminParams)

setImageResolver

public void setImageResolver(TemplateImageResolver imageResolver)

setTestMessageTo

public void setTestMessageTo(String testMessageTo)

getTestMessageTo

public String getTestMessageTo()

setTestMessageSubject

public void setTestMessageSubject(String testMessageSubject)

setTestMessageText

public void setTestMessageText(String testMessageText)

setSendTestMessage

public void setSendTestMessage(boolean sendTestMessage)

sendTestMessage

public boolean sendTestMessage()

Send a test message

Returns:

true, message sent

Throws:

org.alfresco.error.AlfrescoRuntimeException

setTestModeRecipient

public void setTestModeRecipient(String testModeRecipient)

setValidateAddresses

public void setValidateAddresses(boolean validateAddresses)

init

public void init()

Description copied from class: ActionExecuterAbstractBase

Init method

Overrides:

init in class ActionExecuterAbstractBase

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Initialise bean

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

executeImpl

protected void executeImpl(Action ruleAction,
                           org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef)

Send an email message

Specified by:

executeImpl in class ActionExecuterAbstractBase

Parameters:

ruleAction - the action

actionedUponNodeRef - the actioned upon node

Throws:

org.alfresco.error.AlfrescoRuntimeException

prepareEmail

public org.springframework.mail.javamail.MimeMessageHelper prepareEmail(Action ruleAction,
                                                                        org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                                                                        org.alfresco.util.Pair<String,Locale> recipient,
                                                                        org.alfresco.util.Pair<InternetAddress,Locale> sender)

personExists

public boolean personExists(String user)

getPerson

public org.alfresco.service.cmr.repository.NodeRef getPerson(String user)

getPersonEmail

public String getPersonEmail(String user)

addParameterDefinitions

protected void addParameterDefinitions(List<ParameterDefinition> paramList)

Add the parameter definitions

Specified by:

addParameterDefinitions in class ParameterizedItemAbstractBase

Parameters:

paramList - the parameter definitions list

setTestMode

public void setTestMode(boolean testMode)

Specified by:

setTestMode in interface TestModeable

isTestMode

public boolean isTestMode()

Specified by:

isTestMode in interface TestModeable

retrieveLastTestMessage

public MimeMessage retrieveLastTestMessage()

Returns the most recent message that wasn't sent because TestMode had been enabled.

getTestSentCount

public int getTestSentCount()

resetTestSentCount

public int resetTestSentCount()

clearLastTestMessage

public void clearLastTestMessage()

Used when test mode is enabled. Clears the record of the last message that was sent.

setFromEnabled

public void setFromEnabled(boolean fromEnabled)

isFromEnabled

public boolean isFromEnabled()

isHTML

public static boolean isHTML(String value)

onSend

protected void onSend()

onFail

protected void onFail()

getNumberSuccessfulSends

public int getNumberSuccessfulSends()

getNumberFailedSends

public int getNumberFailedSends()