com.day.cq.mcm.exacttarget

Interface ExactTargetClient

public interface ExactTargetClient

ExactTarget Webservice client that makes webservice calls to ExactTarget WebService endpoint.

Method Summary

Modifier and Type	Method and Description
void	addSubscriberToList(Subscriber subscriber) This function calls an ET webservice to add a subscriber to a list.
void	checkCredentials() This function is used to validate the connection parameters with ExactTarget provided while creating the ExactTarget cloudservice configuration
List	createList(List list) This function calls ET WebService to create a list in ET.
void	deleteList(java.lang.String listId) This function calls ET WebService to delete a list from ET.
void	deleteSubscriberFromList(Subscriber subscriber) This function calls ET Webservice to delete a subscriber from a list.
java.util.List<PropertyDefinition>	describeSubscriber() This function calls a webservice that describes the ET subscriber parameters.
java.util.List<Account>	getAccounts(FilterPart filter) This function returns all the accounts associated with the ExactTarget configuration.
java.util.List<Email>	getEmails(FilterPart filter) This function calls ET WebService to get all the emails for an account.
java.util.List<SendClassification>	getSendClassifications(FilterPart filter) This function calls ET WebService to get all the email send classifications for an account.
java.util.List<List>	getSubscriberList(FilterPart filter) This function calls an ET webservice to fetch the subscription lists in ET.
java.util.List<ListSubscriber>	getSubscribers(java.lang.String listId) This function calls ET WebService to get all subscribers on a list in ET.
Email	publishEmail(Email email) This fucntion calls an ET webservice to publish and Email to ET.
java.util.List<DataExtension>	retrieveDataExtension(java.lang.String[] properties, FilterPart filter) This function is used to retrieve filtered data extension objects.
java.util.List<DataExtensionField>	retrieveDataExtensionFields(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(Email email, Subscriber subscriber) This function calls ET WebService to send an email to a subscriber through ET.
void	sendEmail(Email email, SubscriberList subscriberList) This function calls an ET webservice to send an email through ET.
void	updateEmail(Email email) This function calls an ET webservice to update published email on ExactTarget
java.util.Map<java.lang.String,java.lang.String>	viewPublishedNewsletter(java.lang.String entityId)

Method Detail

describeSubscriber

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

This function calls a webservice that describes the ET subscriber parameters.

Returns:

A list of properties containing personlization information provided by ExactTarget

Throws:

ExactTargetException - In case of error.

getSubscriberList

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

This function calls an ET webservice to fetch the subscription lists in ET.

Parameters:

filter - custom filtering parameters to fetch the list.

Returns:

The list of mailing lists available in ET.

Throws:

ExactTargetException - In case of error.

addSubscriberToList

void addSubscriberToList(Subscriber subscriber)
                  throws ExactTargetException

This function calls an ET webservice to add a subscriber to a list.

Parameters:

subscriber - A subscriber that needs to be added to the mailing lists specified within the subscriber , see set lists.

Throws:

ExactTargetException - In case of error.

publishEmail

Email publishEmail(Email email)
            throws ExactTargetException

This fucntion calls an ET webservice to publish and Email to ET.

Parameters:

email - The email object to be published

Returns:

the published email with new properties saved on ExactTarget( like entityID)

Throws:

ExactTargetException - In case of error.

updateEmail

void updateEmail(Email email)
          throws ExactTargetException

This function calls an ET webservice to update published email on ExactTarget

Parameters:

email - The email containing the updated content and ID set to that of the email to be updated on ExactTarget

Throws:

ExactTargetException

sendEmail

void sendEmail(Email email,
               SubscriberList subscriberList)
        throws ExactTargetException

This function calls an ET webservice to send an email through ET.

Parameters:

email - with ID set to that of the existing email on ExactTarget which is meant to be sent. Further emailclassification(customerkey) can be set.

subscriberList - The list to which mail will be sent.

Throws:

ExactTargetException - In case of error.

deleteSubscriberFromList

void deleteSubscriberFromList(Subscriber subscriber)
                       throws ExactTargetException

This function calls ET Webservice to delete a subscriber from a list.

Parameters:

subscriber - The subscriber to be deleted from lists specified within subscriber,see set lists.

Throws:

ExactTargetException - In case of error.

getEmails

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

This function calls ET WebService to get all the emails for an account.

Parameters:

filter - filtering criteria for emails (future use)

Returns:

a List of emails available with the account

Throws:

ExactTargetException - In case of error.

getSendClassifications

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

This function calls ET WebService to get all the email send classifications for an account.

Parameters:

filter - filtering criteria for send classifications (future use)

Returns:

a List of SendClassifications

Throws:

ExactTargetException - In case of error.

sendEmail

void sendEmail(Email email,
               Subscriber subscriber)
        throws ExactTargetException

This function calls ET WebService to send an email to a subscriber through ET.

Parameters:

email - with ID set to that of the existing email on ExactTarget which is meant to be sent. Further emailclassification(customerkey) can be set.

subscriber - The subscriber to which the email has to be sent

Throws:

ExactTargetException - In case of error.

createList

List createList(List list)
         throws ExactTargetException

This function calls ET WebService to create a list in ET.

Parameters:

list - The list to be created

Returns:

the created list.

Throws:

ExactTargetException - In case of error.

deleteList

void deleteList(java.lang.String listId)
         throws ExactTargetException

This function calls ET WebService to delete a list from ET.

Parameters:

listId - ID of the list to be deleted

Throws:

ExactTargetException - In case of error.

getSubscribers

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

This function calls ET WebService to get all subscribers on a list in ET.

Parameters:

listId - ID of the list for which subscribers need to be fetched

Returns:

list of subscribers on the specified list

Throws:

ExactTargetException - In case of error.

getAccounts

java.util.List<Account> getAccounts(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:

filter - Pass null if no filtering needed.

Returns:

A list of all Accounts associated with this connection.

Throws:

ExactTargetException - in case of errors

viewPublishedNewsletter

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

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

Throws:

ExactTargetException

checkCredentials

void checkCredentials()
               throws ExactTargetException

This function is used to validate the connection parameters with ExactTarget provided while creating the ExactTarget cloudservice configuration

Throws:

EmailServiceException - in case of errors.

ExactTargetException

retrieveDataExtension

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

This function is used to retrieve filtered data extension objects.

Parameters:

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(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:

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