Package org.ametys.web.workflow

Class SendMailFunction

java.lang.Object

org.ametys.plugins.workflow.AbstractWorkflowComponent

org.ametys.cms.workflow.AbstractContentWorkflowComponent

org.ametys.cms.workflow.SendMailFunction

org.ametys.web.workflow.SendMailFunction

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider, EnhancedFunction, PluginAware, Initializable, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

SendMailFunction, SendMailToCreatorFunction, SendMailToPersonInChargeFunction, SendMailToUserFunction

public class SendMailFunction
extends SendMailFunction

OS workflow function to send mail after an action is triggered.

Nested Class Summary

Nested classes/interfaces inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

AbstractWorkflowComponent.ConditionFailure

Nested classes/interfaces inherited from interface org.ametys.plugins.workflow.EnhancedFunction

EnhancedFunction.FunctionType

Field Summary

Fields inherited from class org.ametys.cms.workflow.SendMailFunction

_context, _i18nUtils, _pluginName, _rightManager, _rightsExtensionPoint, _sourceResolver, _userManager, _workflowProvider, BODY_KEY, RIGHTS_KEY, SEND_MAIL, SUBJECT_KEY

Fields inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

_contentHelper, CONTENT_KEY, HAS_CHANGED_KEY

Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

_logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_VALIDATION_KEY

Constructor Summary

Constructors

Constructor	Description
SendMailFunction()

Method Summary

Modifier and Type	Method	Description
protected String	_getContentUri(WorkflowAwareContent content, Page page, Site site)	Get the content uri
protected Page	_getPage(WorkflowAwareContent content, Site site)	Get the page referenced by this content
protected Site	_getSite(WorkflowAwareContent content)	Get the site name
protected List<String>	getBodyI18nParams(User user, WorkflowAwareContent content)	Get the i18n parameters of mail body text
I18nizableText	getLabel()	Get the label for this function
protected String	getMailBody(String subjectI18nKey, String bodyI18nKey, User user, WorkflowAwareContent content, Map transientVars)	Get the text body of mail
protected List<String>	getSubjectI18nParams(User user, WorkflowAwareContent content)	Get the i18n parameters of mail subject
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.cms.workflow.SendMailFunction

_getContentUri, _getRequest, _getRequestUri, _getUsers, _sendMails, contextualize, execute, getArguments, getCaller, getFullLabel, getFunctionExecType, getMailSubject, getRecipients, getSender, initialize, setPluginInfo

Methods inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent

getContent

Methods inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent

addWorkflowError, addWorkflowWarning, enableLogging, getConditionFailures, getContextParameters, getResultsMap, getUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.workflow.EnhancedFunction

getVisibilities

Constructor Details

SendMailFunction

public SendMailFunction()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentWorkflowComponent

Throws:

ServiceException

getSubjectI18nParams

protected List<String> getSubjectI18nParams(User user,
 WorkflowAwareContent content)

Description copied from class: SendMailFunction

Get the i18n parameters of mail subject

Overrides:

getSubjectI18nParams in class SendMailFunction

Parameters:

user - the caller

content - the content

Returns:

the i18n parameters

getMailBody

protected String getMailBody(String subjectI18nKey,
 String bodyI18nKey,
 User user,
 WorkflowAwareContent content,
 Map transientVars)
                      throws IOException

Description copied from class: SendMailFunction

Get the text body of mail

Overrides:

getMailBody in class SendMailFunction

Parameters:

subjectI18nKey - the i18n key to use for body's title

bodyI18nKey - the i18n key to use for body

user - the caller

content - the content

transientVars - the transient variables

Returns:

the text body

Throws:

IOException - if an error occurred while building HTML workflow email

getBodyI18nParams

protected List<String> getBodyI18nParams(User user,
 WorkflowAwareContent content)

Description copied from class: SendMailFunction

Get the i18n parameters of mail body text

Overrides:

getBodyI18nParams in class SendMailFunction

Parameters:

user - the caller

content - the content

Returns:

the i18n parameters

_getSite

protected Site _getSite(WorkflowAwareContent content)

Get the site name

Parameters:

content - The content

Returns:

the site name

_getPage

protected Page _getPage(WorkflowAwareContent content,
 Site site)

Get the page referenced by this content

Parameters:

content - The content

site - the site

Returns:

the page or null.

_getContentUri

protected String _getContentUri(WorkflowAwareContent content,
 Page page,
 Site site)

Get the content uri

Parameters:

content - the content

page - the referencing page. Can be null.

site - The site

Returns:

the content uri

getLabel

public I18nizableText getLabel()

Description copied from interface: EnhancedFunction

Get the label for this function

Specified by:

getLabel in interface EnhancedFunction

Overrides:

getLabel in class SendMailFunction

Returns:

the label