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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MailerSendResponsedeleteRecipient(String recipientId)Deletes the recipient with the given idRecipientsdomainId(String domainId)Set the domain IDRecipientgetRecipient(String recipientId)Get a single recipientApiRecipientsListgetRecipients()Get recipientsRecipientslimit(int limit)Set the results limit (10 - 100)Recipientspage(int page)Set the page of the requestSuppressionssuppressions()Get the Suppressions object instance to query the suppressions
-
-
-
Constructor Detail
-
Recipients
public Recipients(MailerSend ref)
Do not initialize directly. This should only be accessed from MailerSend.analytics- Parameters:
ref- aMailerSendobject.
-
-
Method Detail
-
suppressions
public Suppressions suppressions()
Get the Suppressions object instance to query the suppressions- Returns:
- a
Suppressionsobject.
-
page
public Recipients page(int page)
Set the page of the request- Parameters:
page- a int.- Returns:
- a
Recipientsobject.
-
limit
public Recipients limit(int limit)
Set the results limit (10 - 100)- Parameters:
limit- a int.- Returns:
- a
Recipientsobject.
-
domainId
public Recipients domainId(String domainId)
Set the domain ID- Parameters:
domainId- aStringobject.- Returns:
- a
Recipientsobject.
-
getRecipients
public ApiRecipientsList getRecipients() throws MailerSendException
Get recipients- Returns:
- a
ApiRecipientsListobject. - Throws:
MailerSendException
-
getRecipient
public Recipient getRecipient(String recipientId) throws MailerSendException
Get a single recipient- Parameters:
recipientId- aStringobject.- Returns:
- a
Recipientobject. - Throws:
MailerSendException
-
deleteRecipient
public MailerSendResponse deleteRecipient(String recipientId) throws MailerSendException
Deletes the recipient with the given id- Parameters:
recipientId- aStringobject.- Returns:
- a
MailerSendResponseobject. - Throws:
MailerSendException
-
-