MailInformationHelper (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.plugins.forms.workflow.MailInformationHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable
```
public class MailInformationHelper
extends AbstractLogEnabled
implements Component, Serviceable
```
Helper component allowing to retrieve information in order to send emails

Field Summary

Fields
Modifier and Type	Field	Description
`private CurrentUserProvider`	`_currentUserProvider`	The current user provider
`protected static Pattern`	`_EMAIL_PATTERN`	The email validation pattern.
`private FormPropertiesManager`	`_formPropertiesManager`	The manager for the JCR representation of forms
`private FormTableManager`	`_formTableManager`	The manager for the form entries
`private UserManager`	`_userManager`	The user manager
`static String`	`ROLE`	The Avalon role

Constructor Summary

Constructors
Constructor Description

MailInformationHelper()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`getMailInfo(String formId, Integer entryId)`	Get information on the given entry of the given form
`void`	`service(ServiceManager serviceManager)`

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ROLE
```
public static final String ROLE
```
    The Avalon role
  - _EMAIL_PATTERN
```
protected static final Pattern _EMAIL_PATTERN
```
    The email validation pattern.
  - _currentUserProvider
```
private CurrentUserProvider _currentUserProvider
```
    The current user provider
  - _userManager
```
private UserManager _userManager
```
    The user manager
  - _formPropertiesManager
```
private FormPropertiesManager _formPropertiesManager
```
    The manager for the JCR representation of forms
  - _formTableManager
```
private FormTableManager _formTableManager
```
    The manager for the form entries
- Constructor Detail
  - MailInformationHelper
```
public MailInformationHelper()
```
- Method Detail
  - service
```
public void service(ServiceManager serviceManager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Throws:
    
    ServiceException
  - getMailInfo
```
public Map<String,Object> getMailInfo(String formId,
                                            Integer entryId)
```
    Get information on the given entry of the given form
    
    Parameters:
    
    formId - the id of the form
    
    entryId - the id of the entry
    
    Returns:
    
    a map of information on the current user and on the email fields filled in the entry