Package com.mailersend.sdk.recipients

Class Suppressions

java.lang.Object

com.mailersend.sdk.recipients.Suppressions

public class Suppressions
extends Object

Suppressions class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SuppressionAddBuilder	addBuilder()	Get the suppression add builder
MailerSendResponse	deleteBlocklistAllItems()	Deletes all items from the blocklist
MailerSendResponse	deleteBlocklistItems(String[] ids)	Deletes the items with the given id from the blocklist
MailerSendResponse	deleteHardBouncesAllItems()	Deletes all items from the hard bounces suppression list
MailerSendResponse	deleteHardBouncesItems(String[] ids)	Deletes the items with the given id from the hard bounces suppression list
MailerSendResponse	deleteSpamComplaintsAllItems()	Deletes all items from the spam complaints suppression list
MailerSendResponse	deleteSpamComplaintsItems(String[] ids)	Deletes the items with the given id from the spam complaints suppression list
MailerSendResponse	deleteUnsubscribesAllItems()	Deletes all items from the unsubscribes suppression list
MailerSendResponse	deleteUnsubscribesItems(String[] ids)	Deletes the items with the given id from the unsubscribes suppression list
Suppressions	domainId(String domainId)	Set the domain ID
BlocklistListResponse	getBlocklist()	Gets the recipients in a blocklist of an account or domain
SuppressionList	getHardBounces()	Gets the recipients that hard bounced
SuppressionList	getSpamComplaints()	Gets the spam complaints
SuppressionList	getUnsubscribes()	Gets the unsubscribes
Suppressions	limit(int limit)	Set the results limit (10 - 100)
Suppressions	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

Suppressions

public Suppressions(MailerSend ref)

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

Parameters:

ref - a MailerSend object.

Method Detail

addBuilder

public SuppressionAddBuilder addBuilder()

Get the suppression add builder

Returns:

a SuppressionAddBuilder object.

page

public Suppressions page(int page)

Set the page of the request

Parameters:

page - a int.

Returns:

a Suppressions object.

limit

public Suppressions limit(int limit)

Set the results limit (10 - 100)

Parameters:

limit - a int.

Returns:

a Suppressions object.

domainId

public Suppressions domainId(String domainId)

Set the domain ID

Parameters:

domainId - a String object.

Returns:

a Suppressions object.

getBlocklist

public BlocklistListResponse getBlocklist()
                                   throws MailerSendException

Gets the recipients in a blocklist of an account or domain

Returns:

a BlocklistListResponse object.

Throws:

MailerSendException

getHardBounces

public SuppressionList getHardBounces()
                               throws MailerSendException

Gets the recipients that hard bounced

Returns:

a SuppressionList object.

Throws:

MailerSendException

getSpamComplaints

public SuppressionList getSpamComplaints()
                                  throws MailerSendException

Gets the spam complaints

Returns:

a SuppressionList object.

Throws:

MailerSendException

getUnsubscribes

public SuppressionList getUnsubscribes()
                                throws MailerSendException

Gets the unsubscribes

Returns:

a SuppressionList object.

Throws:

MailerSendException

deleteBlocklistItems

public MailerSendResponse deleteBlocklistItems(String[] ids)
                                        throws MailerSendException

Deletes the items with the given id from the blocklist

Parameters:

ids - an array of String objects.

Returns:

a MailerSendResponse object.

Throws:

MailerSendException

deleteBlocklistAllItems

public MailerSendResponse deleteBlocklistAllItems()
                                           throws MailerSendException

Deletes all items from the blocklist

Returns:

a MailerSendResponse object.

Throws:

MailerSendException

deleteHardBouncesItems

public MailerSendResponse deleteHardBouncesItems(String[] ids)
                                          throws MailerSendException

Deletes the items with the given id from the hard bounces suppression list

Parameters:

ids - an array of String objects.

Returns:

a MailerSendResponse object.

Throws:

MailerSendException

deleteHardBouncesAllItems

public MailerSendResponse deleteHardBouncesAllItems()
                                             throws MailerSendException

Deletes all items from the hard bounces suppression list

Returns:

a MailerSendResponse object.

Throws:

MailerSendException

deleteSpamComplaintsItems

public MailerSendResponse deleteSpamComplaintsItems(String[] ids)
                                             throws MailerSendException

Deletes the items with the given id from the spam complaints suppression list

Parameters:

ids - an array of String objects.

Returns:

a MailerSendResponse object.

Throws:

MailerSendException

deleteSpamComplaintsAllItems

public MailerSendResponse deleteSpamComplaintsAllItems()
                                                throws MailerSendException

Deletes all items from the spam complaints suppression list

Returns:

a MailerSendResponse object.

Throws:

MailerSendException

deleteUnsubscribesItems

public MailerSendResponse deleteUnsubscribesItems(String[] ids)
                                           throws MailerSendException

Deletes the items with the given id from the unsubscribes suppression list

Parameters:

ids - an array of String objects.

Returns:

a MailerSendResponse object.

Throws:

MailerSendException

deleteUnsubscribesAllItems

public MailerSendResponse deleteUnsubscribesAllItems()
                                              throws MailerSendException

Deletes all items from the unsubscribes suppression list

Returns:

a MailerSendResponse object.

Throws:

MailerSendException