Interface IBounceControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IBounceControllerApiAsync : IApiAccessor

Methods

View Source

FilterBouncedRecipientAsync(FilterBouncedRecipientsOptions, int, CancellationToken)

Filter a list of email recipients and remove those who have bounced

Declaration
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
Remarks

Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

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

Declaration
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)
Remarks

Prevent email sending errors by remove recipients who have resulted in past email bounces or complaints

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAccountBounceBlockStatusAsync(int, CancellationToken)

Can account send email

Declaration
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
Remarks

Check if account block status prevents sending

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAccountBounceBlockStatusWithHttpInfoAsync(int, CancellationToken)

Can account send email

Declaration
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)
Remarks

Check if account block status prevents sending

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetBouncedEmailAsync(Guid, int, CancellationToken)

Get a bounced email.

Declaration
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
Remarks

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

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.

Declaration
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
Remarks

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

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.

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetBouncedEmailWithHttpInfoAsync(Guid, int, CancellationToken)

Get a bounced email.

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetBouncedRecipientAsync(Guid, int, CancellationToken)

Get a bounced email.

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get paginated list of bounced recipients.

Declaration
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
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get paginated list of bounced recipients.

Declaration
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)
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetBouncedRecipientWithHttpInfoAsync(Guid, int, CancellationToken)

Get a bounced email.

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetComplaintAsync(Guid, int, CancellationToken)

Get complaint

Declaration
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
Remarks

Get complaint

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.

Declaration
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
Remarks

SMTP complaints made against your account

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.

Declaration
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)
Remarks

SMTP complaints made against your account

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetComplaintWithHttpInfoAsync(Guid, int, CancellationToken)

Get complaint

Declaration
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)
Remarks

Get complaint

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.

Declaration
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
Remarks

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

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.

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call