Package org.ametys.plugins.forms.helper

Class FormMailHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.helper.FormMailHelper

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class FormMailHelper
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

The helper for form mail dialog

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FormMailHelper.LimitationMailType	The type of limitation for the mail

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The context
protected static final String	_FORM_ENTRY_PATTERN	Pattern for adding entry in acknowledgement of receipt if present in body
protected FormAdminMailsHelper	_formAdminMailsHelper	The form admin mail helper
protected FormDAO	_formDAO	The analyse of files for virus helper
protected I18nUtils	_i18nUtils	I18n Utils
protected AmetysObjectResolver	_resolver	Ametys object resolver.
protected SourceResolver	_sourceResolver	The source resolver.
protected UserManager	_userManager	The user manager
static final String	IGNORE_RIGHT_KEY	The request key to ignore right
static final String	READ_RESTRICTION_ENABLE	The param key for read restriction enable
static final String	RECEIVER_COMBOBOX_ENTRY_USER_VALUE	The value for entry user in the receiver combobox
static final String	RECEIVER_COMBOBOX_INPUT_ONLY	The empty value in the receiver combobox
static final String	ROLE	Avalon ROLE.

Constructor Summary

Constructors

Constructor	Description
FormMailHelper()

Method Summary

Modifier and Type	Method	Description
protected Collection<SendMailHelper.NamedStream>	_getFiles(Form form, FormEntry entry)	Get the files of a user input.
protected String	_getFormURI(Form form, String language)	Get the form page URI
void	contextualize(Context context)
String[]	getAdminEmails(Form form, FormEntry entry)	Get all the email addresses from manual entry and/or a form field
Map<String,Object>	getAvailableAdminReceiverFields(String formId)	Get the fields with email regex constraint so they can be used as receivers address for form admin mail
Map<String,Object>	getAvailableReceiverFields(String formId)	Get the fields with email regex constraint so they can be used as receivers address for form receipt mail
String	getMail(String resource, FormEntry entry, Map<String,Object> additionalParameters, boolean withReadingRestriction)	Get a mail pipeline's content.
List<FormQuestion>	getQuestionWithMail(String formId)	Get the list of questions which return a mail
Optional<String>	getReceiver(FormEntry entry, Optional<String> receiverPath)	Get the receiver from the entry
void	sendEmailsForAdmin(Form form, FormEntry entry, String[] adminEmails)	Send the notification emails.
void	sendInvitationMails(Form form, List<User> users, String message)	Send invitation mails to the users
void	sendLimitationReachedMailForAdmin(FormEntry entry, String[] adminEmails, FormMailHelper.LimitationMailType limitationType)	Send limitation mail when the limit is reached
void	sendOutOfQueueMail(Form form, FormEntry entry)	Send mail when the form entry if out of the queue
void	sendReceiptEmail(Form form, FormEntry entry)	Send the receipt email.
void	service(ServiceManager manager)

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 Details

ROLE

public static final String ROLE

Avalon ROLE.

READ_RESTRICTION_ENABLE

public static final String READ_RESTRICTION_ENABLE

The param key for read restriction enable

See Also:

• Constant Field Values

RECEIVER_COMBOBOX_ENTRY_USER_VALUE

public static final String RECEIVER_COMBOBOX_ENTRY_USER_VALUE

The value for entry user in the receiver combobox

See Also:

• Constant Field Values

RECEIVER_COMBOBOX_INPUT_ONLY

public static final String RECEIVER_COMBOBOX_INPUT_ONLY

The empty value in the receiver combobox

See Also:

• Constant Field Values

IGNORE_RIGHT_KEY

public static final String IGNORE_RIGHT_KEY

The request key to ignore right

See Also:

• Constant Field Values

_FORM_ENTRY_PATTERN

protected static final String _FORM_ENTRY_PATTERN

Pattern for adding entry in acknowledgement of receipt if present in body

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver.

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_userManager

protected UserManager _userManager

The user manager

_sourceResolver

protected SourceResolver _sourceResolver

The source resolver.

_context

protected Context _context

The context

_formDAO

protected FormDAO _formDAO

The analyse of files for virus helper

_formAdminMailsHelper

protected FormAdminMailsHelper _formAdminMailsHelper

The form admin mail helper

Constructor Details

FormMailHelper

public FormMailHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getAvailableAdminReceiverFields

public Map<String,Object> getAvailableAdminReceiverFields(String formId)

Get the fields with email regex constraint so they can be used as receivers address for form admin mail

Parameters:

formId - Id of the form

Returns:

a map of the form question, key is the question id,value is the question title

getAvailableReceiverFields

public Map<String,Object> getAvailableReceiverFields(String formId)

Get the fields with email regex constraint so they can be used as receivers address for form receipt mail

Parameters:

formId - Id of the form

Returns:

a map of the form question, key is the question id,value is the question title

getQuestionWithMail

public List<FormQuestion> getQuestionWithMail(String formId)

Get the list of questions which return a mail

Parameters:

formId - the form id

Returns:

the list of questions

getAdminEmails

public String[] getAdminEmails(Form form,
 FormEntry entry)

Get all the email addresses from manual entry and/or a form field

Parameters:

form - the form

entry - the last entry

Returns:

an array of all the admin emails

getReceiver

public Optional<String> getReceiver(FormEntry entry,
 Optional<String> receiverPath)

Get the receiver from the entry

Parameters:

entry - the entry

receiverPath - the path to get receiver

Returns:

the receiver from the entry

sendEmailsForAdmin

public void sendEmailsForAdmin(Form form,
 FormEntry entry,
 String[] adminEmails)

Send the notification emails.

Parameters:

form - the form.

entry - the user input.

adminEmails - list of email address where to send the notification

sendLimitationReachedMailForAdmin

public void sendLimitationReachedMailForAdmin(FormEntry entry,
 String[] adminEmails,
 FormMailHelper.LimitationMailType limitationType)

Send limitation mail when the limit is reached

Parameters:

entry - the form entry

adminEmails - list of email address where to send the notification

limitationType - the type of limitation

sendReceiptEmail

public void sendReceiptEmail(Form form,
 FormEntry entry)

Send the receipt email.

Parameters:

form - the form.

entry - the current entry

sendOutOfQueueMail

public void sendOutOfQueueMail(Form form,
 FormEntry entry)

Send mail when the form entry if out of the queue

Parameters:

form - the form

entry - the form entry

sendInvitationMails

public void sendInvitationMails(Form form,
 List<User> users,
 String message)

Send invitation mails to the users

Parameters:

form - the form

users - the users to receive the mail

message - the invitation message

_getFormURI

protected String _getFormURI(Form form,
 String language)

Get the form page URI

Parameters:

form - the form

language - the language

Returns:

the form page URI

getMail

public String getMail(String resource,
 FormEntry entry,
 Map<String,Object> additionalParameters,
 boolean withReadingRestriction)
               throws IOException

Get a mail pipeline's content.

Parameters:

resource - the mail resource pipeline

entry - the user input.

additionalParameters - the additional parameters

withReadingRestriction - true to enable reading restriction for form data in the mail

Returns:

the mail content.

Throws:

IOException - if an error occurs.

_getFiles

protected Collection<SendMailHelper.NamedStream> _getFiles(Form form,
 FormEntry entry)

Get the files of a user input.

Parameters:

form - The current form

entry - The current entry

Returns:

the files submitted by the user.