com.day.cq.mcm.exacttarget

Interface ExactTargetService

All Superinterfaces:

EmailService

public interface ExactTargetService
extends EmailService

Method Summary

Modifier and Type	Method and Description
void	addSubscriberToList(Configuration configuration, Subscriber subscriber) This function is used to add a subscriber to subscription lists.
void	checkCredentials(ConnectionParams connectionParams) This function is used to validate the connection parameters associated with ExactTarget
List	createList(Configuration configuration, List list) This function will create a subscription list on ExactTarget.
void	deleteList(Configuration configuration, java.lang.String listId) This function will delete specified subscription list from ExactTarget.
void	deleteSubscriberFromList(Configuration configuration, Subscriber subscriber) This function is used to delete a subscriber to subscription lists.
java.util.List<PropertyDefinition>	describeSubscriber(Configuration configuration) This function fetches the personalisation elements from ExactTarget
java.util.List<Account>	getAccounts(ConnectionParams connectionParams, FilterPart filter) This function returns all the accounts associated with the ExactTarget configuration.
java.util.List<Email>	getEmails(Configuration configuration, FilterPart filter) This function will get a list of all mails that are available with ExactTarget for this account.
java.util.List<SendClassification>	getSendClassifications(Configuration configuration, FilterPart filter) This function returns the Classification types for sending an email.
java.util.List<List>	getSubscriberList(Configuration configuration, FilterPart filter) This function is used to return all subscription lists available with ExactTarget account.
java.util.List<ListSubscriber>	getSubscribers(Configuration configuration, java.lang.String listId) This function will get all the subscribers that are subscribed on the specified list.
Email	publishEmail(Configuration configuration, Email email) This function is used to publish an email to ExactTarget.
java.util.List<DataExtension>	retrieveDataExtension(Configuration configuration, java.lang.String[] properties, FilterPart filter) This function is used to retrieve filtered data extension objects.
java.util.List<DataExtensionField>	retrieveDataExtensionFields(Configuration configuration, FilterPart filter, java.lang.String[] fields) This function is used to retrieve data extension columns from the data extension specified in the filter
void	sendEmail(Configuration configuration, Email email, Subscriber subscriber) This function is used to send an email to a subscriber.
void	sendEmail(Configuration configuration, Email email, SubscriberList subcriberList) This function is used to send an email to a subscriberList.
void	updateEmail(Configuration configuration, Email email) This function is used to update a published email on an external email provider
java.util.Map<java.lang.String,java.lang.String>	viewPublishedNewsletter(Configuration configuration, java.lang.String entityId) This operation is specific to ExactTarget

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

execute, getName

Method Detail

getAccounts

java.util.List<Account> getAccounts(ConnectionParams connectionParams,
                                    FilterPart filter)
                             throws ExactTargetException

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

Parameters:

connectionParams - The connection parameters to connect to ExactTarget.

filter - Pass null if no filtering needed.

Returns:

A list of all Accounts associated with this connection.

Throws:

ExactTargetException - in case of errors

checkCredentials

void checkCredentials(ConnectionParams connectionParams)
               throws ExactTargetException

This function is used to validate the connection parameters associated with ExactTarget

Parameters:

params - The ConnectionParams for ExactTarget.

Throws:

ExactTargetException - in case of errors.

addSubscriberToList

void addSubscriberToList(Configuration configuration,
                         Subscriber subscriber)
                  throws ExactTargetException

This function is used to add a subscriber to subscription lists.

Parameters:

configuration - ExactTarget configuration from cloud services.

subscriber - The Subscriber object containing information about the subscriber and the subscription listscom.day.cq.mcm.exacttarget.client.Subscriber#setLists(SubscriberList[])..

Throws:

ExactTargetException - in case of errors.

deleteSubscriberFromList

void deleteSubscriberFromList(Configuration configuration,
                              Subscriber subscriber)
                       throws ExactTargetException

This function is used to delete a subscriber to subscription lists.

Parameters:

configuration - ExactTarget configuration from cloud services.

subscriber - The Subscriber object containing information about the subscriber and the subscription listscom.day.cq.mcm.exacttarget.client.Subscriber#setLists(SubscriberList[])..

Throws:

ExactTargetException - in case of errors.

publishEmail

Email publishEmail(Configuration configuration,
                   Email email)
            throws ExactTargetException

This function is used to publish an email to ExactTarget.

Parameters:

configuration - ExactTarget configuration from cloud services.

email - The email to be published

Returns:

the published email with new properties(entityID: identifier of email on ET) saved on ExactTarget

Throws:

ExactTargetException - in case of errors.

updateEmail

void updateEmail(Configuration configuration,
                 Email email)
          throws ExactTargetException

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

Parameters:

configuration - ExactTarget configuration from cloud services

email - The email containing the updates with ID set to corresponding email entity on ExactTarget

Throws:

ExactTargetException

sendEmail

void sendEmail(Configuration configuration,
               Email email,
               Subscriber subscriber)
        throws ExactTargetException

This function is used to send an email to a subscriber.

Parameters:

configuration - ExactTarget configuration from cloud services.

email - Email object containing information about email like ID and customerKey

subscriber - The subscriber to which the email will be sent.

Throws:

ExactTargetException - in case of errors.

sendEmail

void sendEmail(Configuration configuration,
               Email email,
               SubscriberList subcriberList)
        throws ExactTargetException

This function is used to send an email to a subscriberList.

Parameters:

configuration - ExactTarget configuration from cloud services.

email - Email object containing information about email like ID and customerKey

subscriberList - The list to which the email will be sent.

Throws:

ExactTargetException - in case of errors.

getSubscribers

java.util.List<ListSubscriber> getSubscribers(Configuration configuration,
                                              java.lang.String listId)
                                       throws ExactTargetException

This function will get all the subscribers that are subscribed on the specified list.

Parameters:

configuration - ExactTarget configuration from cloud services.

listId - identifier of the subscription list for which subscribers need to be fetched.

Returns:

A list containing all the subscriber objects subscribed to the list.

Throws:

ExactTargetException - in case of errors.

deleteList

void deleteList(Configuration configuration,
                java.lang.String listId)
         throws ExactTargetException

This function will delete specified subscription list from ExactTarget.

Parameters:

configuration - ExactTarget configuration from cloud services.

listId - The identifier of the subscription list to be deleted.

Throws:

ExactTargetException - in case of errors.

createList

List createList(Configuration configuration,
                List list)
         throws ExactTargetException

This function will create a subscription list on ExactTarget.

Parameters:

configuration - ExactTarget configuration from cloud services.

list - List containing information on the list to be created

Throws:

ExactTargetException - in case of errors.

getSendClassifications

java.util.List<SendClassification> getSendClassifications(Configuration configuration,
                                                          FilterPart filter)
                                                   throws ExactTargetException

This function returns the Classification types for sending an email.

Parameters:

configuration - ExactTarget configuration from cloud services.

filter - Filter containing send classification filters, pass null for no filtering.

Returns:

A List containing all SendClassification objects for the available classifications.

Throws:

ExactTargetException - in case of errors.

getEmails

java.util.List<Email> getEmails(Configuration configuration,
                                FilterPart filter)
                         throws ExactTargetException

This function will get a list of all mails that are available with ExactTarget for this account.

Parameters:

configuration - ExactTarget configuration from cloud services.

filter - Filter containing Email filters. Pass null for no filter.

Returns:

A list containing all Email objects.

Throws:

ExactTargetException - in case of errors.

viewPublishedNewsletter

java.util.Map<java.lang.String,java.lang.String> viewPublishedNewsletter(Configuration configuration,
                                                                         java.lang.String entityId)
                                                                  throws ExactTargetException

This operation is specific to ExactTarget

Parameters:

params - The parameter to connect to ExactTarget

entityId - Id of the published email/newsletter as saved on ExactTarget

Returns:

Map containing LoginUrl and UserToken to view the published email on ExactTarget. A post request from browser on the LoginUrl with post param UserToken will open the published email on ExactTarget.

Throws:

ExactTargetException

getSubscriberList

java.util.List<List> getSubscriberList(Configuration configuration,
                                       FilterPart filter)
                                throws ExactTargetException

This function is used to return all subscription lists available with ExactTarget account.

Parameters:

configuration - ExactTarget configuration from cloud services.

filter - Filter containing list filters. Pass null for no filter.

Returns:

a List containing ET List objects for each subscription list available with ExactTarget account.

Throws:

ExactTargetException - in case of errors.

describeSubscriber

java.util.List<PropertyDefinition> describeSubscriber(Configuration configuration)
                                               throws ExactTargetException

This function fetches the personalisation elements from ExactTarget

Parameters:

configuration - ExactTarget Configuration from cloud services

Returns:

List containing PropertyDefinition available on ExactTarget

Throws:

ExactTargetException - in case of errors.

retrieveDataExtension

java.util.List<DataExtension> retrieveDataExtension(Configuration configuration,
                                                    java.lang.String[] properties,
                                                    FilterPart filter)
                                             throws ExactTargetException

This function is used to retrieve filtered data extension objects.

Parameters:

configuration - ExactTarget Configuration from cloud services

properties - The properties of the data extension to be retrieved.

filter - Filter to be applied while retrieving, e.g, IsSendable equals true

Returns:

A list of DataExtension objects

Throws:

ExactTargetException - in case of errors

retrieveDataExtensionFields

java.util.List<DataExtensionField> retrieveDataExtensionFields(Configuration configuration,
                                                               FilterPart filter,
                                                               java.lang.String[] fields)
                                                        throws ExactTargetException

This function is used to retrieve data extension columns from the data extension specified in the filter

Parameters:

configuration - ExactTarget Configuration from cloud services

filter - Filter should specify the DataExtension whose columns are to be retrieved, e.g., DataExtension.CustomerKey equals *****

fields - Attributes of the columns, e.g., Name, DefaultValue, etc.

Returns:

A list of data extension column fields

Throws:

ExactTargetException - in case of errors