Package com.day.cq.mcm.emailprovider
Interface EmailService
-
public interface EmailService
This is a provider interface that needs to be implemented for integration of external email providers with CQ.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
execute(EmailServiceActions op, java.util.Map<java.lang.String,java.lang.Object> params, Configuration config)
java.lang.String
getName()
Every email provider will be identified by a name.
-
-
-
Method Detail
-
getName
java.lang.String getName()
Every email provider will be identified by a name. This method should return the name of the email provider. This name should be part of the cloud service configuration (as providerName property) so that it can be used to identify the email provider implementation associated with the cloud service configuration.- Returns:
- The name of the email provider.
-
execute
java.lang.Object execute(EmailServiceActions op, java.util.Map<java.lang.String,java.lang.Object> params, Configuration config) throws EmailServiceException
- Parameters:
op
- The operation to be performed by the email service providerparams
- parameters needed for the operation- Returns:
- An object, typically converted to JSON needed for configurations on client side or NULL if the operation is not about configuration. The following can be expected as return: a List
- Throws:
EmailServiceException
-
-