Package com.mailersend.sdk.messages

Class Messages

java.lang.Object

com.mailersend.sdk.messages.Messages

public class Messages
extends Object

Messages class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

Constructor	Description
Messages(MailerSend ref)	Constructor for Messages.

Method Summary

Modifier and Type	Method	Description
Message	getMessage(String messageId)	Gets a single message
MessagesList	getMessages()	Gets a list of messages
Messages	limit(int limit)	Set the results limit (10 - 100)
Messages	page(int page)	Set the page of the request

Methods inherited from class java.lang.Object

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

Constructor Detail

Messages

public Messages(MailerSend ref)

Constructor for Messages.

Parameters:

ref - a MailerSend object.

Method Detail

page

public Messages page(int page)

Set the page of the request

Parameters:

page - a int.

Returns:

a Messages object.

limit

public Messages limit(int limit)

Set the results limit (10 - 100)

Parameters:

limit - a int.

Returns:

a Messages object.

getMessages

public MessagesList getMessages()
                         throws MailerSendException

Gets a list of messages

Returns:

a MessagesList object.

Throws:

MailerSendException

getMessage

public Message getMessage(String messageId)
                   throws MailerSendException

Gets a single message

Parameters:

messageId - a String object.

Returns:

a Message object.

Throws:

MailerSendException