com.createsend

Class Messages

java.lang.Object

com.createsend.CreateSendBase

com.createsend.Messages

public class Messages
extends CreateSendBase

Provides methods for accessing all Transactional Message 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
Messages(AuthenticationDetails auth)

Method Summary

Modifier and Type	Method and Description
Message	get(UUID messageID)
Message	get(UUID messageID, boolean includeStatistics)
MessageSent	resend(UUID messageID) Resend a message.
TransactionalStatistics	statistics(String clientID, UUID smartEmailID, String group, Date from, Date to, String timezone) Gets statistics for a range of messages.
MessageLogItem[]	timeline(String clientID, UUID sentBeforeID, UUID sentAfterID, Integer count, String status, UUID smartEmailID, String group) Perform a sliding window request of the delivery log.

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

Messages

public Messages(AuthenticationDetails auth)

Parameters:

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

Method Detail

get

public Message get(UUID messageID)
            throws CreateSendException

Returns:

get message by message id.

Throws:

CreateSendException

get

public Message get(UUID messageID,
                   boolean includeStatistics)
            throws CreateSendException

Parameters:

messageID -

includeStatistics - include statistics.

Returns:

get message by message id, optionally including statistics.

Throws:

CreateSendException

statistics

public TransactionalStatistics statistics(String clientID,
                                          UUID smartEmailID,
                                          String group,
                                          Date from,
                                          Date to,
                                          String timezone)
                                   throws CreateSendException

Gets statistics for a range of messages.

Parameters:

clientID - optional Client ID to filter.

smartEmailID - optional Smart Email ID.

group - optional Group.

from - optional From address.

to - optional To address.

timezone - optional timezone.

Returns:

the message activity statistics.

Throws:

CreateSendException

resend

public MessageSent resend(UUID messageID)
                   throws CreateSendException

Resend a message. Message may have a retention limit and might not always be valid to resend.

Parameters:

messageID - the message id to resend.

Returns:

Message sent acknowledgement.

Throws:

CreateSendException

timeline

public MessageLogItem[] timeline(String clientID,
                                 UUID sentBeforeID,
                                 UUID sentAfterID,
                                 Integer count,
                                 String status,
                                 UUID smartEmailID,
                                 String group)
                          throws CreateSendException

Perform a sliding window request of the delivery log.

Parameters:

clientID - optional Client ID to filter.

sentBeforeID - optional start range. Find message sent before this id.

sentAfterID - optional end range. Find message sent after this id.

count - optional count, number of messages to retrieve.

status - optional message status filter.

smartEmailID - optional filter to a specific smart email.

group - optional filter to a specific group.

Returns:

Throws:

CreateSendException