Interface EmailService


  • public interface EmailService
    This is a provider interface that needs to be implemented for integration of external email providers with CQ.
    • 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 provider
        params - 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 corresponding to JSONArray, a Map corresponding to JSONObject or just an Object depending on the operation. Note the List can contain another List, Map or Object and the Map can contain another List, Map or Object as Value of key.
        Throws:
        EmailServiceException