Package com.mailersend.sdk.recipients

Class Recipients

java.lang.Object

com.mailersend.sdk.recipients.Recipients

public class Recipients
extends Object

Recipients class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

Constructor	Description
Recipients(MailerSend ref)	Do not initialize directly.

Method Summary

Modifier and Type	Method	Description
MailerSendResponse	deleteRecipient(String recipientId)	Deletes the recipient with the given id
Recipients	domainId(String domainId)	Set the domain ID
Recipient	getRecipient(String recipientId)	Get a single recipient
ApiRecipientsList	getRecipients()	Get recipients
Recipients	limit(int limit)	Set the results limit (10 - 100)
Recipients	page(int page)	Set the page of the request
Suppressions	suppressions()	Get the Suppressions object instance to query the suppressions

Methods inherited from class java.lang.Object

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

Constructor Detail

Recipients

public Recipients(MailerSend ref)

Do not initialize directly. This should only be accessed from MailerSend.analytics

Parameters:

ref - a MailerSend object.

Method Detail

suppressions

public Suppressions suppressions()

Get the Suppressions object instance to query the suppressions

Returns:

a Suppressions object.

page

public Recipients page(int page)

Set the page of the request

Parameters:

page - a int.

Returns:

a Recipients object.

limit

public Recipients limit(int limit)

Set the results limit (10 - 100)

Parameters:

limit - a int.

Returns:

a Recipients object.

domainId

public Recipients domainId(String domainId)

Set the domain ID

Parameters:

domainId - a String object.

Returns:

a Recipients object.

getRecipients

public ApiRecipientsList getRecipients()
                                throws MailerSendException

Get recipients

Returns:

a ApiRecipientsList object.

Throws:

MailerSendException

getRecipient

public Recipient getRecipient(String recipientId)
                       throws MailerSendException

Get a single recipient

Parameters:

recipientId - a String object.

Returns:

a Recipient object.

Throws:

MailerSendException

deleteRecipient

public MailerSendResponse deleteRecipient(String recipientId)
                                   throws MailerSendException

Deletes the recipient with the given id

Parameters:

recipientId - a String object.

Returns:

a MailerSendResponse object.

Throws:

MailerSendException