com.createsend

Class SmartEmail

java.lang.Object

com.createsend.CreateSendBase

com.createsend.SmartEmail

public class SmartEmail
extends CreateSendBase

Provides methods for accessing all Transactional Smart Email resources in the Campaign Monitor API

Field Summary

Fields inherited from class com.createsend.CreateSendBase

jerseyClient, URL_ENCODING_SCHEME

Constructor Summary

Constructors

Constructor and Description
SmartEmail(AuthenticationDetails auth)

Method Summary

Modifier and Type	Method and Description
SmartEmailDetails	get(UUID smartEmailId) Get a SmartEmail by SmartEmailID.
SmartEmailItem[]	list() List SmartEmails.
SmartEmailItem[]	list(SmartEmailStatus status) List SmartEmails, filtered by status.
SmartEmailItem[]	list(SmartEmailStatus status, String clientID) List SmartEmails, filtered by status for a specific Client.
SmartEmailItem[]	list(String clientID) List SmartEmails, filtered for a specific Client.
MessageSent[]	send(SmartEmailRequest smartEmailRequest) Send a SmartEmail.

Methods inherited from class com.createsend.CreateSendBase

refreshToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SmartEmail

public SmartEmail(AuthenticationDetails auth)

Parameters:

auth - The authentication details to use when making API calls. May be either an OAuthAuthenticationDetails or ApiKeyAuthenticationDetails instance.

Method Detail

list

public SmartEmailItem[] list()
                      throws CreateSendException

List SmartEmails.

Returns:

Array of SmartEmailItem.

Throws:

CreateSendException

list

public SmartEmailItem[] list(SmartEmailStatus status)
                      throws CreateSendException

List SmartEmails, filtered by status.

Parameters:

status -

Returns:

Throws:

CreateSendException

list

public SmartEmailItem[] list(String clientID)
                      throws CreateSendException

List SmartEmails, filtered for a specific Client.

Parameters:

clientID -

Returns:

Throws:

CreateSendException

list

public SmartEmailItem[] list(SmartEmailStatus status,
                             String clientID)
                      throws CreateSendException

List SmartEmails, filtered by status for a specific Client.

Parameters:

status -

clientID -

Returns:

Throws:

CreateSendException

get

public SmartEmailDetails get(UUID smartEmailId)
                      throws CreateSendException

Get a SmartEmail by SmartEmailID.

Parameters:

smartEmailId -

Returns:

SmartEmailDetails

Throws:

CreateSendException

send

public MessageSent[] send(SmartEmailRequest smartEmailRequest)
                   throws CreateSendException

Send a SmartEmail.

Parameters:

smartEmailRequest - The SmartEmailRequest to send.

Returns:

Message sent acknowledgement.

Throws:

CreateSendException