SendMailFunction (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.plugins.workflow.AbstractWorkflowComponent
- - org.ametys.cms.workflow.AbstractContentWorkflowComponent
  - - org.ametys.cms.workflow.SendMailFunction
    - - org.ametys.web.workflow.SendMailFunction
      - org.ametys.plugins.odfweb.workflow.SendMailFunction

All Implemented Interfaces:

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

Direct Known Subclasses:

SendMailToUserFunction
```
public class SendMailFunction
extends SendMailFunction
```
OS workflow function to send mail after an action is triggered on ODF contents

Field Summary

Fields
Modifier and Type Field Description

private OdfPageResolver _odfPageResolver

private SiteManager _siteManager
- Fields inherited from class org.ametys.cms.workflow.SendMailFunction
  _context, _currentUserProvider, _i18nUtils, _pluginName, _rightManager, _sourceResolver, _userManager, _workflowProvider, BODY_KEY, RIGHTS_KEY, SEND_MAIL, SUBJECT_KEY
- Fields inherited from class org.ametys.cms.workflow.AbstractContentWorkflowComponent
  _contentHelper, CONTENT_KEY
- Fields inherited from class org.ametys.plugins.workflow.AbstractWorkflowComponent
  _logger, _manager, CONTEXT_PARAMETERS_KEY, FAIL_CONDITIONS_KEY, RESULT_MAP_KEY, WORKFLOW_ERRORS_KEY, WORKFLOW_WARNS_KEY

Constructor Summary

Constructors
Constructor Description

SendMailFunction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Page`	`_getPage(WorkflowAwareContent content, Site site)`	Get the page referenced by this content
`protected Site`	`_getSite(WorkflowAwareContent content)`	Get the site name
`void`	`service(ServiceManager manager)`

Methods inherited from class org.ametys.web.workflow.SendMailFunction
_getContentUri, getBodyI18nParams, getMailBody, getSubjectI18nParams

Methods inherited from class org.ametys.cms.workflow.SendMailFunction
_getContentUri, _getRequest, _getRequestUri, _getUsers, _sendMails, contextualize, execute, getCaller, 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

- Field Detail
  - _odfPageResolver
```
private OdfPageResolver _odfPageResolver
```
  - _siteManager
```
private SiteManager _siteManager
```
- Constructor Detail
  - SendMailFunction
```
public SendMailFunction()
```
- Method Detail
  - service
```
public void service(ServiceManager manager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class AbstractContentWorkflowComponent
    
    Throws:
    
    ServiceException
  - _getSite
```
protected Site _getSite(WorkflowAwareContent content)
```
    Description copied from class: SendMailFunction
    
    Get the site name
    
    Overrides:
    
    _getSite in class SendMailFunction
    
    Parameters:
    
    content - The content
    
    Returns:
    
    the site name
  - _getPage
```
protected Page _getPage(WorkflowAwareContent content,
                        Site site)
```
    Description copied from class: SendMailFunction
    
    Get the page referenced by this content
    
    Overrides:
    
    _getPage in class SendMailFunction
    
    Parameters:
    
    content - The content
    
    site - the site
    
    Returns:
    
    the page or null.