com.mailslurp.apis

Class BounceControllerApi

java.lang.Object

com.mailslurp.apis.BounceControllerApi

public class BounceControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
BounceControllerApi()
BounceControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
FilterBouncedRecipientsResult	filterBouncedRecipient(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions) Filter a list of email recipients and remove those who have bounced Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
okhttp3.Call	filterBouncedRecipientAsync(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, ApiCallback<FilterBouncedRecipientsResult> _callback) Filter a list of email recipients and remove those who have bounced (asynchronously) Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
okhttp3.Call	filterBouncedRecipientCall(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, ApiCallback _callback) Build call for filterBouncedRecipient
ApiResponse<FilterBouncedRecipientsResult>	filterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions) Filter a list of email recipients and remove those who have bounced Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints
ApiClient	getApiClient()
BouncedEmailDto	getBouncedEmail(UUID id) Get a bounced email.
okhttp3.Call	getBouncedEmailAsync(UUID id, ApiCallback<BouncedEmailDto> _callback) Get a bounced email.
okhttp3.Call	getBouncedEmailCall(UUID id, ApiCallback _callback) Build call for getBouncedEmail
PageBouncedEmail	getBouncedEmails(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get paginated list of bounced emails.
okhttp3.Call	getBouncedEmailsAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageBouncedEmail> _callback) Get paginated list of bounced emails.
okhttp3.Call	getBouncedEmailsCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getBouncedEmails
ApiResponse<PageBouncedEmail>	getBouncedEmailsWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get paginated list of bounced emails.
ApiResponse<BouncedEmailDto>	getBouncedEmailWithHttpInfo(UUID id) Get a bounced email.
BouncedRecipientDto	getBouncedRecipient(UUID id) Get a bounced email.
okhttp3.Call	getBouncedRecipientAsync(UUID id, ApiCallback<BouncedRecipientDto> _callback) Get a bounced email.
okhttp3.Call	getBouncedRecipientCall(UUID id, ApiCallback _callback) Build call for getBouncedRecipient
PageBouncedRecipients	getBouncedRecipients(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get paginated list of bounced recipients.
okhttp3.Call	getBouncedRecipientsAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageBouncedRecipients> _callback) Get paginated list of bounced recipients.
okhttp3.Call	getBouncedRecipientsCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getBouncedRecipients
ApiResponse<PageBouncedRecipients>	getBouncedRecipientsWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get paginated list of bounced recipients.
ApiResponse<BouncedRecipientDto>	getBouncedRecipientWithHttpInfo(UUID id) Get a bounced email.
PageComplaint	getComplaints(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get paginated list of complaints.
okhttp3.Call	getComplaintsAsync(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback<PageComplaint> _callback) Get paginated list of complaints.
okhttp3.Call	getComplaintsCall(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before, ApiCallback _callback) Build call for getComplaints
ApiResponse<PageComplaint>	getComplaintsWithHttpInfo(Integer page, Integer size, String sort, OffsetDateTime since, OffsetDateTime before) Get paginated list of complaints.
String	getCustomBaseUrl()
int	getHostIndex()
PageListUnsubscribeRecipients	getListUnsubscribeRecipients(Integer page, Integer size, String sort, UUID domainId) Get paginated list of unsubscribed recipients.
okhttp3.Call	getListUnsubscribeRecipientsAsync(Integer page, Integer size, String sort, UUID domainId, ApiCallback<PageListUnsubscribeRecipients> _callback) Get paginated list of unsubscribed recipients.
okhttp3.Call	getListUnsubscribeRecipientsCall(Integer page, Integer size, String sort, UUID domainId, ApiCallback _callback) Build call for getListUnsubscribeRecipients
ApiResponse<PageListUnsubscribeRecipients>	getListUnsubscribeRecipientsWithHttpInfo(Integer page, Integer size, String sort, UUID domainId) Get paginated list of unsubscribed recipients.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

BounceControllerApi

public BounceControllerApi()

BounceControllerApi

public BounceControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

filterBouncedRecipientCall

public okhttp3.Call filterBouncedRecipientCall(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions,
                                               ApiCallback _callback)
                                        throws ApiException

Build call for filterBouncedRecipient

Parameters:

filterBouncedRecipientsOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

filterBouncedRecipient

public FilterBouncedRecipientsResult filterBouncedRecipient(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions)
                                                     throws ApiException

Filter a list of email recipients and remove those who have bounced Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

Parameters:

filterBouncedRecipientsOptions - (required)

Returns:

FilterBouncedRecipientsResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

filterBouncedRecipientWithHttpInfo

public ApiResponse<FilterBouncedRecipientsResult> filterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions)
                                                                              throws ApiException

Filter a list of email recipients and remove those who have bounced Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

Parameters:

filterBouncedRecipientsOptions - (required)

Returns:

ApiResponse<FilterBouncedRecipientsResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

filterBouncedRecipientAsync

public okhttp3.Call filterBouncedRecipientAsync(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions,
                                                ApiCallback<FilterBouncedRecipientsResult> _callback)
                                         throws ApiException

Filter a list of email recipients and remove those who have bounced (asynchronously) Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

Parameters:

filterBouncedRecipientsOptions - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmailCall

public okhttp3.Call getBouncedEmailCall(UUID id,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getBouncedEmail

Parameters:

id - ID of the bounced email to fetch (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmail

public BouncedEmailDto getBouncedEmail(UUID id)
                                throws ApiException

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Parameters:

id - ID of the bounced email to fetch (required)

Returns:

BouncedEmailDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmailWithHttpInfo

public ApiResponse<BouncedEmailDto> getBouncedEmailWithHttpInfo(UUID id)
                                                         throws ApiException

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Parameters:

id - ID of the bounced email to fetch (required)

Returns:

ApiResponse<BouncedEmailDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmailAsync

public okhttp3.Call getBouncedEmailAsync(UUID id,
                                         ApiCallback<BouncedEmailDto> _callback)
                                  throws ApiException

Get a bounced email. (asynchronously) Bounced emails are email you have sent that were rejected by a recipient

Parameters:

id - ID of the bounced email to fetch (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmailsCall

public okhttp3.Call getBouncedEmailsCall(Integer page,
                                         Integer size,
                                         String sort,
                                         OffsetDateTime since,
                                         OffsetDateTime before,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for getBouncedEmails

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmails

public PageBouncedEmail getBouncedEmails(Integer page,
                                         Integer size,
                                         String sort,
                                         OffsetDateTime since,
                                         OffsetDateTime before)
                                  throws ApiException

Get paginated list of bounced emails. Bounced emails are email you have sent that were rejected by a recipient

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageBouncedEmail

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmailsWithHttpInfo

public ApiResponse<PageBouncedEmail> getBouncedEmailsWithHttpInfo(Integer page,
                                                                  Integer size,
                                                                  String sort,
                                                                  OffsetDateTime since,
                                                                  OffsetDateTime before)
                                                           throws ApiException

Get paginated list of bounced emails. Bounced emails are email you have sent that were rejected by a recipient

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageBouncedEmail>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedEmailsAsync

public okhttp3.Call getBouncedEmailsAsync(Integer page,
                                          Integer size,
                                          String sort,
                                          OffsetDateTime since,
                                          OffsetDateTime before,
                                          ApiCallback<PageBouncedEmail> _callback)
                                   throws ApiException

Get paginated list of bounced emails. (asynchronously) Bounced emails are email you have sent that were rejected by a recipient

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipientCall

public okhttp3.Call getBouncedRecipientCall(UUID id,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for getBouncedRecipient

Parameters:

id - ID of the bounced recipient (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipient

public BouncedRecipientDto getBouncedRecipient(UUID id)
                                        throws ApiException

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Parameters:

id - ID of the bounced recipient (required)

Returns:

BouncedRecipientDto

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipientWithHttpInfo

public ApiResponse<BouncedRecipientDto> getBouncedRecipientWithHttpInfo(UUID id)
                                                                 throws ApiException

Get a bounced email. Bounced emails are email you have sent that were rejected by a recipient

Parameters:

id - ID of the bounced recipient (required)

Returns:

ApiResponse<BouncedRecipientDto>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipientAsync

public okhttp3.Call getBouncedRecipientAsync(UUID id,
                                             ApiCallback<BouncedRecipientDto> _callback)
                                      throws ApiException

Get a bounced email. (asynchronously) Bounced emails are email you have sent that were rejected by a recipient

Parameters:

id - ID of the bounced recipient (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipientsCall

public okhttp3.Call getBouncedRecipientsCall(Integer page,
                                             Integer size,
                                             String sort,
                                             OffsetDateTime since,
                                             OffsetDateTime before,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for getBouncedRecipients

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipients

public PageBouncedRecipients getBouncedRecipients(Integer page,
                                                  Integer size,
                                                  String sort,
                                                  OffsetDateTime since,
                                                  OffsetDateTime before)
                                           throws ApiException

Get paginated list of bounced recipients. Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageBouncedRecipients

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipientsWithHttpInfo

public ApiResponse<PageBouncedRecipients> getBouncedRecipientsWithHttpInfo(Integer page,
                                                                           Integer size,
                                                                           String sort,
                                                                           OffsetDateTime since,
                                                                           OffsetDateTime before)
                                                                    throws ApiException

Get paginated list of bounced recipients. Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageBouncedRecipients>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getBouncedRecipientsAsync

public okhttp3.Call getBouncedRecipientsAsync(Integer page,
                                              Integer size,
                                              String sort,
                                              OffsetDateTime since,
                                              OffsetDateTime before,
                                              ApiCallback<PageBouncedRecipients> _callback)
                                       throws ApiException

Get paginated list of bounced recipients. (asynchronously) Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address.

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getComplaintsCall

public okhttp3.Call getComplaintsCall(Integer page,
                                      Integer size,
                                      String sort,
                                      OffsetDateTime since,
                                      OffsetDateTime before,
                                      ApiCallback _callback)
                               throws ApiException

Build call for getComplaints

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getComplaints

public PageComplaint getComplaints(Integer page,
                                   Integer size,
                                   String sort,
                                   OffsetDateTime since,
                                   OffsetDateTime before)
                            throws ApiException

Get paginated list of complaints. SMTP complaints made against your account

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

PageComplaint

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getComplaintsWithHttpInfo

public ApiResponse<PageComplaint> getComplaintsWithHttpInfo(Integer page,
                                                            Integer size,
                                                            String sort,
                                                            OffsetDateTime since,
                                                            OffsetDateTime before)
                                                     throws ApiException

Get paginated list of complaints. SMTP complaints made against your account

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

Returns:

ApiResponse<PageComplaint>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getComplaintsAsync

public okhttp3.Call getComplaintsAsync(Integer page,
                                       Integer size,
                                       String sort,
                                       OffsetDateTime since,
                                       OffsetDateTime before,
                                       ApiCallback<PageComplaint> _callback)
                                throws ApiException

Get paginated list of complaints. (asynchronously) SMTP complaints made against your account

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getListUnsubscribeRecipientsCall

public okhttp3.Call getListUnsubscribeRecipientsCall(Integer page,
                                                     Integer size,
                                                     String sort,
                                                     UUID domainId,
                                                     ApiCallback _callback)
                                              throws ApiException

Build call for getListUnsubscribeRecipients

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

domainId - Filter by domainId (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getListUnsubscribeRecipients

public PageListUnsubscribeRecipients getListUnsubscribeRecipients(Integer page,
                                                                  Integer size,
                                                                  String sort,
                                                                  UUID domainId)
                                                           throws ApiException

Get paginated list of unsubscribed recipients. Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

domainId - Filter by domainId (optional)

Returns:

PageListUnsubscribeRecipients

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getListUnsubscribeRecipientsWithHttpInfo

public ApiResponse<PageListUnsubscribeRecipients> getListUnsubscribeRecipientsWithHttpInfo(Integer page,
                                                                                           Integer size,
                                                                                           String sort,
                                                                                           UUID domainId)
                                                                                    throws ApiException

Get paginated list of unsubscribed recipients. Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

domainId - Filter by domainId (optional)

Returns:

ApiResponse<PageListUnsubscribeRecipients>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getListUnsubscribeRecipientsAsync

public okhttp3.Call getListUnsubscribeRecipientsAsync(Integer page,
                                                      Integer size,
                                                      String sort,
                                                      UUID domainId,
                                                      ApiCallback<PageListUnsubscribeRecipients> _callback)
                                               throws ApiException

Get paginated list of unsubscribed recipients. (asynchronously) Unsubscribed recipient have unsubscribed from a mailing list for a user or domain and cannot be contacted again.

Parameters:

page - Optional page index (optional, default to 0)

size - Optional page size (optional, default to 20)

sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

domainId - Filter by domainId (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-