com.adobe.cq.mcm.silverpop

Interface SilverPopService

All Superinterfaces:

EmailService

public interface SilverPopService
extends EmailService

Method Summary

Methods

Modifier and Type	Method and Description
void	addSubscriberToList(Configuration configuration, Subscriber subscriber, SubscriptionList[] lists, String parentDB) This function is used to add a subscriber to a particular subscription list.
void	checkCredentials(ConnectionParams params) This function is used to validate the connection parameters with SilverPop
void	deleteSubscriberFromList(Configuration configuration, Subscriber subscriber, SubscriptionList[] lists, String parentDB) This function is used to remove a subscriber from a particular mailing list.
PersonalizationInfo	describeSubscriber(Configuration configuration, String listId) This function fetches the personalisation elements from SilverPop
List<Account>	getAccounts(ConnectionParams params, Map<String,Object> filterMap) This function returns all the accounts associated with the email provider configuration.
List<FieldDescription>	getFormFields(Configuration configuration, String listId, EmailServiceActions formAction) Deprecated. since 5.6.1
List<ListAttribute>	getListAttributes(Configuration configuration, String listId)
List<SubscriptionList>	getLists(Configuration configuration, Map<String,Object> filterMap) This function is used to return all subscription lists available with the email provider account.
List<MailingTemplate>	getMailingTemplates(Configuration configuration, GetMailingTemplateParams params)
Email	publishEmail(Configuration configuration, Email email) This function is used to publish an email to an external email provider.
void	scheduleMailing(Configuration configuration, ScheduleMailingParams params)
void	updateEmail(Configuration configuration, Email email) This function is used to update a published email on an external email provider

Methods inherited from interface com.day.cq.mcm.emailprovider.EmailService

execute, getName

Method Detail

checkCredentials

void checkCredentials(ConnectionParams params)
                      throws SilverPopException

This function is used to validate the connection parameters with SilverPop

Parameters:

params - The ConnectionParams for SilverPop.

Throws:

SilverPopException - in case of errors.

getLists

List<SubscriptionList> getLists(Configuration configuration,
                              Map<String,Object> filterMap)
                                throws SilverPopException

This function is used to return all subscription lists available with the email provider account.

Parameters:

configuration - The email provider configuration from cloud services.

Returns:

a List containing SubscriptionList objects for each subscription list available with the email provider.

Throws:

SilverPopException - in case of errors.

addSubscriberToList

void addSubscriberToList(Configuration configuration,
                       Subscriber subscriber,
                       SubscriptionList[] lists,
                       String parentDB)
                         throws SilverPopException

This function is used to add a subscriber to a particular subscription list.

Parameters:

configuration - The email provider configuration from cloud services.

subscriber - The Subscriber object containing information about the subscriber.

lists - The lists to which the subscriber will be added. Note the lists should belong to same parent database at SilverPop

parentDB - The parentDB associated with the lists. If lists are null, the subscriber will be added to the parentDB

Throws:

SilverPopException - in case of errors.

deleteSubscriberFromList

void deleteSubscriberFromList(Configuration configuration,
                            Subscriber subscriber,
                            SubscriptionList[] lists,
                            String parentDB)
                              throws SilverPopException

This function is used to remove a subscriber from a particular mailing list.

Parameters:

configuration - The email provider configuration from cloud services.

subscriber - The Subscriber object containing information about the subscriber.

lists - The lists from which the subscriber will be removed. The lists must share the same parent database at SilverPop. If lists are null, the subscriber will be removed from the parentDB.

parentDB - The parent database id associated with the lists

Throws:

SilverPopException - in case of errors.

publishEmail

Email publishEmail(Configuration configuration,
                 Email email)
                   throws SilverPopException

This function is used to publish an email to an external email provider.

Parameters:

configuration - The email provider configuration from cloud services.

email - An object implementing Email containing details about email to be published

Returns:

the published email with new properties saved on external email provider

Throws:

SilverPopException - in case of errors.

updateEmail

void updateEmail(Configuration configuration,
               Email email)
                 throws SilverPopException

This function is used to update a published email on an external email provider

Parameters:

configuration - The email provider configuration from cloud services

email - An object implementing Email containing details about email to be updated

Throws:

SilverPopException

getAccounts

List<Account> getAccounts(ConnectionParams params,
                        Map<String,Object> filterMap)
                          throws SilverPopException

This function returns all the accounts associated with the email provider configuration. If an email provider supports multiple accounts for a connection then those accounts can be fetched by implementing this API.

Parameters:

params - The connection parameters to connect to the email provider.

filterMap - A map containing filtering criteria if any for account filtering. This will be implementation specific.

Returns:

A list of all Accounts associated with this connection.

Throws:

SilverPopException - in case of errors.

describeSubscriber

PersonalizationInfo describeSubscriber(Configuration configuration,
                                     String listId)
                                       throws SilverPopException

This function fetches the personalisation elements from SilverPop

Parameters:

configuration - SilverPop Configuration from cloud services

listId - Contact list existing on SilverPop

Returns:

PersonalizationInfo associated with the list

Throws:

SilverPopException - in case of errors.

getFormFields

@Deprecated
List<FieldDescription> getFormFields(Configuration configuration,
                                              String listId,
                                              EmailServiceActions formAction)
                                     throws SilverPopException

Deprecated. since 5.6.1

Parameters:

configuration - SilverPop Configuration from cloud services

listId - Contact list existing on Silverpop

formAction - EmailServiceActions{ADD_SUBSCRIBER, DELETE_SUBSCRIBER, SEND_AUTO_RESPONDER}

Returns:

A list of FieldDescription needed to execute the given formAction on associated list.

Throws:

SilverPopException

See Also:

SilverPopService#getListAttributes(Configuration, String) getListAttributes} This function returns the form input fields need to execute corresponding formAction on list listID.

getListAttributes

List<ListAttribute> getListAttributes(Configuration configuration,
                                    String listId)
                                      throws SilverPopException

Parameters:

listId - The list or database whose attributes are to be fetched

Returns:

The list of attributes in the list

Throws:

SilverpopException

SilverPopException

getMailingTemplates

List<MailingTemplate> getMailingTemplates(Configuration configuration,
                                        GetMailingTemplateParams params)
                                          throws SilverPopException

Throws:

SilverPopException

scheduleMailing

void scheduleMailing(Configuration configuration,
                   ScheduleMailingParams params)
                     throws SilverPopException

Throws:

SilverPopException