Package ch.tocco.nice2.optional.address.impl.action.mail

Interface MailReceiverService

All Known Implementing Classes:

MailReceiverServiceImpl

public interface MailReceiverService

Method Summary

Modifier and Type	Method	Description
List<MailReceiver>	getMailReceiver(MailSettings.FormProperties formProperties, EntityList list)	This method invokes either one of the other two `#getMailReceiver()` based on which properties have been set in the `request` parameter.
List<MailReceiver>	getMailReceiver(Iterable<String> recipientPath, Iterable<String> email, Iterable<String> firstname, Iterable<String> lastname, EntityList list)	Finds all receivers by resolving the `recipientPath` path list to possibly multiple entities and from there the `email`, `firstname` and `lastname` paths are resolved to collect all data necessary for a `MailReceiver`.
List<MailReceiver>	getMailReceiver(String emailPath, String firstnamePath, String lastnamePath, EntityList list)	Collects the mail receviers from three unrelated pathes.
List<MailReceiver>	getMailReceivers(MailSettings mailSettings, Entity fakeSingleBase, EntityList selectionList, boolean isFirstBatch)

Method Details

getMailReceiver

List<MailReceiver> getMailReceiver(Iterable<String> recipientPath,
 Iterable<String> email,
 Iterable<String> firstname,
 Iterable<String> lastname,
 EntityList list)

Finds all receivers by resolving the `recipientPath` path list to possibly multiple entities and from there the `email`, `firstname` and `lastname` paths are resolved to collect all data necessary for a `MailReceiver`. The ´recipientPath` is a list of paths (separated by comma "`,`"), that resolve to an entity that is considered the "recipient-base". From there the other paths are resolved to obtain the mail address and the corresponding first- and lastname.

getMailReceiver

List<MailReceiver> getMailReceiver(String emailPath,
 String firstnamePath,
 String lastnamePath,
 EntityList list)

Collects the mail receviers from three unrelated pathes. Creates at most one receiver per element in `list`.

getMailReceiver

List<MailReceiver> getMailReceiver(MailSettings.FormProperties formProperties,
 EntityList list)

This method invokes either one of the other two `#getMailReceiver()` based on which properties have been set in the `request` parameter. If the request has valid `getRecipientXyz` configuration, then getMailReceiver(Iterable, Iterable, Iterable, Iterable, EntityList) is invoked, otherwise getMailReceiver(String, String, String, EntityList).

getMailReceivers

List<MailReceiver> getMailReceivers(MailSettings mailSettings,
 Entity fakeSingleBase,
 EntityList selectionList,
 boolean isFirstBatch)

Parameters:

isFirstBatch - if receivers are created in batches (for memory reasons), this value is true for the first batch. this allows to make sure to execute certain actions only once per mailing (for example single-copy receivers).