com.messagegears.sdk

Class MessageGearsClient

java.lang.Object

com.messagegears.sdk.MessageGearsClient

public class MessageGearsClient
extends java.lang.Object

The MessageGears Java API implementation. This class is designed to easily allow integration with the MessageGears API.

Author:

tjones

Constructor Summary

Constructors

Constructor and Description
MessageGearsClient(MessageGearsProperties properties) Constructs a new MessageGears client using the specified properties.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	accountActivity(AccountActivityRequest request) Used to download the detailed xml activity report for a given
AccountSummaryResponse	accountSummary(AccountSummaryRequest request) Used to return a summary of total account activity (clicks, bounces, opens, deliveries, etc...) for a given day.
BulkJobSubmitResponse	bulkCampaignSubmit(BulkCampaignSubmitRequest request)
BulkJobSubmitResponse	bulkJobSubmit(BulkJobSubmitRequest request)
BulkJobSummaryResponse	bulkJobSummary(BulkJobSummaryRequest request) Used to return a summary of total activity (clicks, bounces, opens, deliveries, etc...) for a given bulk job by supplying the RequestId.
CreateAccountResponse	createAccount(CreateAccountRequest request)
ForwardToAFriendResponse	forwardToAFriendSubmit(ForwardToAFriendRequest request) Submits a ForwardToAFriend Job (to a single recipient) for processing.
MessagePreviewResponse	messagePreview(MessagePreviewRequest request) Allows you to submit your message content for rendering without actually sending an email message.
JobStateResponse	retrieveJobState(JobStateRetrievalRequest request) Used to return the state (Pause/Resume/Cancel) of a bulk job with a given job request id.
JobStateResponse	setJobState(JobStateRequest request) Used to update the state (Pause/Resume/Cancel) of a bulk job with a given job request id.
ThumbnailResponse	thumbnail(ThumbnailRequest request)
TransactionalJobSubmitResponse	transactionalCampaignSubmit(TransactionalCampaignSubmitRequest request)
TransactionalContent	transactionalContentRetrieval(TransactionalContentRetrievalRequest request) Used to return the rendered content of a transactional job or campaign by supplying the OriginalRequestId.
TransactionalJobSubmitResponse	transactionalJobSubmit(TransactionalJobSubmitRequest request) Submits a Transactional Job (to a single recipient) for processing.
UpdateAccountResponse	updateAccount(UpdateAccountRequest request)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageGearsClient

public MessageGearsClient(MessageGearsProperties properties)

Constructs a new MessageGears client using the specified properties.

Parameters:

properties - The account credentials and any other items of data required to use the service.

Method Detail

createAccount

public CreateAccountResponse createAccount(CreateAccountRequest request)

updateAccount

public UpdateAccountResponse updateAccount(UpdateAccountRequest request)

thumbnail

public ThumbnailResponse thumbnail(ThumbnailRequest request)

transactionalCampaignSubmit

public TransactionalJobSubmitResponse transactionalCampaignSubmit(TransactionalCampaignSubmitRequest request)

transactionalJobSubmit

public TransactionalJobSubmitResponse transactionalJobSubmit(TransactionalJobSubmitRequest request)

Submits a Transactional Job (to a single recipient) for processing.

Parameters:

request - A @TransactionalJobSubmitRequest

Returns:

A @TransactionalJobSubmitResponse

bulkJobSubmit

public BulkJobSubmitResponse bulkJobSubmit(BulkJobSubmitRequest request)

bulkCampaignSubmit

public BulkJobSubmitResponse bulkCampaignSubmit(BulkCampaignSubmitRequest request)

messagePreview

public MessagePreviewResponse messagePreview(MessagePreviewRequest request)

Allows you to submit your message content for rendering without actually sending an email message. This can be used to determine if the template and recipient data contain any rendering errors. The response also contains a SpamAssassin spam score based on the content of the template. This data can be used to determine if the message content may trigger any spam filtering rules when it is actually sent.

Parameters:

request - A @MessagePreviewRequest

Returns:

A @MessagePreviewResponse

transactionalContentRetrieval

public TransactionalContent transactionalContentRetrieval(TransactionalContentRetrievalRequest request)

Used to return the rendered content of a transactional job or campaign by supplying the OriginalRequestId.

Parameters:

request - A @TransactionalContentRetrievalRequest.

Returns:

A @TransactionalContent.

setJobState

public JobStateResponse setJobState(JobStateRequest request)

Used to update the state (Pause/Resume/Cancel) of a bulk job with a given job request id.

Parameters:

request - A @TransactionalContentRetrievalRequest.

Returns:

A @TransactionalContent.

retrieveJobState

public JobStateResponse retrieveJobState(JobStateRetrievalRequest request)

Used to return the state (Pause/Resume/Cancel) of a bulk job with a given job request id.

Parameters:

request - A @TransactionalContentRetrievalRequest.

Returns:

A @TransactionalContent.

accountSummary

public AccountSummaryResponse accountSummary(AccountSummaryRequest request)

Used to return a summary of total account activity (clicks, bounces, opens, deliveries, etc...) for a given day.

Parameters:

request - A @AccountSummaryRequest.

Returns:

A @AccountSummaryResponse.

bulkJobSummary

public BulkJobSummaryResponse bulkJobSummary(BulkJobSummaryRequest request)

Used to return a summary of total activity (clicks, bounces, opens, deliveries, etc...) for a given bulk job by supplying the RequestId.

Parameters:

request - A @BulkJobSummaryRequest.

Returns:

A @BulkJobSummaryResponse.

accountActivity

public java.lang.String accountActivity(AccountActivityRequest request)

Used to download the detailed xml activity report for a given

Parameters:

request - A @AccountActivityRequest.

Returns:

A @AccountActivityResponse.

forwardToAFriendSubmit

public ForwardToAFriendResponse forwardToAFriendSubmit(ForwardToAFriendRequest request)

Submits a ForwardToAFriend Job (to a single recipient) for processing.

Parameters:

request - A @TransactionalJobSubmitRequest

Returns:

A @TransactionalJobSubmitResponse