Class BounceControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

BounceControllerApi

Implements

IBounceControllerApi

IBounceControllerApiSync

IBounceControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class BounceControllerApi : IBounceControllerApi, IBounceControllerApiSync, IBounceControllerApiAsync, IApiAccessor

Constructors

View Source

BounceControllerApi()

Initializes a new instance of the BounceControllerApi class.

Declaration

public BounceControllerApi()

View Source

BounceControllerApi(Configuration)

Initializes a new instance of the BounceControllerApi class using Configuration object

Declaration

public BounceControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

BounceControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the BounceControllerApi class using a Configuration object and client instance.

Declaration

public BounceControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

View Source

BounceControllerApi(string)

Initializes a new instance of the BounceControllerApi class.

Declaration

public BounceControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

FilterBouncedRecipient(FilterBouncedRecipientsOptions, int)

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

Declaration

public FilterBouncedRecipientsResult FilterBouncedRecipient(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
FilterBouncedRecipientsOptions	filterBouncedRecipientsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
FilterBouncedRecipientsResult	FilterBouncedRecipientsResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FilterBouncedRecipientAsync(FilterBouncedRecipientsOptions, int, CancellationToken)

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

Declaration

public Task<FilterBouncedRecipientsResult> FilterBouncedRecipientAsync(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FilterBouncedRecipientsOptions	filterBouncedRecipientsOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<FilterBouncedRecipientsResult>	Task of FilterBouncedRecipientsResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FilterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions, int)

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

Declaration

public ApiResponse<FilterBouncedRecipientsResult> FilterBouncedRecipientWithHttpInfo(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, int operationIndex = 0)

Parameters

Type	Name	Description
FilterBouncedRecipientsOptions	filterBouncedRecipientsOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<FilterBouncedRecipientsResult>	ApiResponse of FilterBouncedRecipientsResult

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

FilterBouncedRecipientWithHttpInfoAsync(FilterBouncedRecipientsOptions, int, CancellationToken)

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

Declaration

public Task<ApiResponse<FilterBouncedRecipientsResult>> FilterBouncedRecipientWithHttpInfoAsync(FilterBouncedRecipientsOptions filterBouncedRecipientsOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
FilterBouncedRecipientsOptions	filterBouncedRecipientsOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<FilterBouncedRecipientsResult>>	Task of ApiResponse (FilterBouncedRecipientsResult)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAccountBounceBlockStatus(int)

Can account send email Check if account block status prevents sending

Declaration

public AccountBounceBlockDto GetAccountBounceBlockStatus(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
AccountBounceBlockDto	AccountBounceBlockDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAccountBounceBlockStatusAsync(int, CancellationToken)

Can account send email Check if account block status prevents sending

Declaration

public Task<AccountBounceBlockDto> GetAccountBounceBlockStatusAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<AccountBounceBlockDto>	Task of AccountBounceBlockDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAccountBounceBlockStatusWithHttpInfo(int)

Can account send email Check if account block status prevents sending

Declaration

public ApiResponse<AccountBounceBlockDto> GetAccountBounceBlockStatusWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<AccountBounceBlockDto>	ApiResponse of AccountBounceBlockDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetAccountBounceBlockStatusWithHttpInfoAsync(int, CancellationToken)

Can account send email Check if account block status prevents sending

Declaration

public Task<ApiResponse<AccountBounceBlockDto>> GetAccountBounceBlockStatusWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<AccountBounceBlockDto>>	Task of ApiResponse (AccountBounceBlockDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetBouncedEmail(Guid, int)

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

Declaration

public BouncedEmailDto GetBouncedEmail(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced email to fetch
int	operationIndex	Index associated with the operation.

Returns

Type	Description
BouncedEmailDto	BouncedEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedEmailAsync(Guid, int, CancellationToken)

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

Declaration

public Task<BouncedEmailDto> GetBouncedEmailAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced email to fetch
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<BouncedEmailDto>	Task of BouncedEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedEmails(int?, int?, string, DateTime?, DateTime?, int)

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

Declaration

public PageBouncedEmail GetBouncedEmails(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageBouncedEmail	PageBouncedEmail

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedEmailsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

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

Declaration

public Task<PageBouncedEmail> GetBouncedEmailsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageBouncedEmail>	Task of PageBouncedEmail

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedEmailsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

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

Declaration

public ApiResponse<PageBouncedEmail> GetBouncedEmailsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageBouncedEmail>	ApiResponse of PageBouncedEmail

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedEmailsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

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

Declaration

public Task<ApiResponse<PageBouncedEmail>> GetBouncedEmailsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageBouncedEmail>>	Task of ApiResponse (PageBouncedEmail)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedEmailWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<BouncedEmailDto> GetBouncedEmailWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced email to fetch
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<BouncedEmailDto>	ApiResponse of BouncedEmailDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedEmailWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public Task<ApiResponse<BouncedEmailDto>> GetBouncedEmailWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced email to fetch
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<BouncedEmailDto>>	Task of ApiResponse (BouncedEmailDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipient(Guid, int)

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

Declaration

public BouncedRecipientDto GetBouncedRecipient(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced recipient
int	operationIndex	Index associated with the operation.

Returns

Type	Description
BouncedRecipientDto	BouncedRecipientDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipientAsync(Guid, int, CancellationToken)

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

Declaration

public Task<BouncedRecipientDto> GetBouncedRecipientAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced recipient
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<BouncedRecipientDto>	Task of BouncedRecipientDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipients(int?, int?, string, DateTime?, DateTime?, int)

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.

Declaration

public PageBouncedRecipients GetBouncedRecipients(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageBouncedRecipients	PageBouncedRecipients

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipientsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

public Task<PageBouncedRecipients> GetBouncedRecipientsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageBouncedRecipients>	Task of PageBouncedRecipients

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipientsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

Declaration

public ApiResponse<PageBouncedRecipients> GetBouncedRecipientsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageBouncedRecipients>	ApiResponse of PageBouncedRecipients

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipientsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

Declaration

public Task<ApiResponse<PageBouncedRecipients>> GetBouncedRecipientsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageBouncedRecipients>>	Task of ApiResponse (PageBouncedRecipients)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipientWithHttpInfo(Guid, int)

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

Declaration

public ApiResponse<BouncedRecipientDto> GetBouncedRecipientWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced recipient
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<BouncedRecipientDto>	ApiResponse of BouncedRecipientDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBouncedRecipientWithHttpInfoAsync(Guid, int, CancellationToken)

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

Declaration

public Task<ApiResponse<BouncedRecipientDto>> GetBouncedRecipientWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of the bounced recipient
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<BouncedRecipientDto>>	Task of ApiResponse (BouncedRecipientDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaint(Guid, int)

Get complaint Get complaint

Declaration

public Complaint GetComplaint(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of the complaint
int	operationIndex	Index associated with the operation.

Returns

Type	Description
Complaint	Complaint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaintAsync(Guid, int, CancellationToken)

Get complaint Get complaint

Declaration

public Task<Complaint> GetComplaintAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of the complaint
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<Complaint>	Task of Complaint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaints(int?, int?, string, DateTime?, DateTime?, int)

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

Declaration

public PageComplaint GetComplaints(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageComplaint	PageComplaint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaintsAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

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

Declaration

public Task<PageComplaint> GetComplaintsAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageComplaint>	Task of PageComplaint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaintsWithHttpInfo(int?, int?, string, DateTime?, DateTime?, int)

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

Declaration

public ApiResponse<PageComplaint> GetComplaintsWithHttpInfo(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageComplaint>	ApiResponse of PageComplaint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaintsWithHttpInfoAsync(int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

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

Declaration

public Task<ApiResponse<PageComplaint>> GetComplaintsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageComplaint>>	Task of ApiResponse (PageComplaint)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaintWithHttpInfo(Guid, int)

Get complaint Get complaint

Declaration

public ApiResponse<Complaint> GetComplaintWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of the complaint
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<Complaint>	ApiResponse of Complaint

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetComplaintWithHttpInfoAsync(Guid, int, CancellationToken)

Get complaint Get complaint

Declaration

public Task<ApiResponse<Complaint>> GetComplaintWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of the complaint
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<Complaint>>	Task of ApiResponse (Complaint)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetListUnsubscribeRecipients(int?, int?, string, Guid?, int)

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

Declaration

public PageListUnsubscribeRecipients GetListUnsubscribeRecipients(int? page = null, int? size = null, string sort = null, Guid? domainId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
System.Guid?	domainId	Filter by domainId (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageListUnsubscribeRecipients	PageListUnsubscribeRecipients

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetListUnsubscribeRecipientsAsync(int?, int?, string, Guid?, int, CancellationToken)

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

Declaration

public Task<PageListUnsubscribeRecipients> GetListUnsubscribeRecipientsAsync(int? page = null, int? size = null, string sort = null, Guid? domainId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
System.Guid?	domainId	Filter by domainId (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageListUnsubscribeRecipients>	Task of PageListUnsubscribeRecipients

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetListUnsubscribeRecipientsWithHttpInfo(int?, int?, string, Guid?, int)

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

Declaration

public ApiResponse<PageListUnsubscribeRecipients> GetListUnsubscribeRecipientsWithHttpInfo(int? page = null, int? size = null, string sort = null, Guid? domainId = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
System.Guid?	domainId	Filter by domainId (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageListUnsubscribeRecipients>	ApiResponse of PageListUnsubscribeRecipients

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetListUnsubscribeRecipientsWithHttpInfoAsync(int?, int?, string, Guid?, int, CancellationToken)

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

Declaration

public Task<ApiResponse<PageListUnsubscribeRecipients>> GetListUnsubscribeRecipientsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, Guid? domainId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	Optional page index (optional, default to 0)
int?	size	Optional page size (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
System.Guid?	domainId	Filter by domainId (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageListUnsubscribeRecipients>>	Task of ApiResponse (PageListUnsubscribeRecipients)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IBounceControllerApi

IBounceControllerApiSync

IBounceControllerApiAsync

IApiAccessor