Interface IEmailVerificationControllerApiAsync

Represents a collection of functions to interact with the API endpoints

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

Methods

View Source

DeleteAllValidationRequestsAsync(int, CancellationToken)

Delete all validation requests

Declaration
Task DeleteAllValidationRequestsAsync(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

Task of void
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllValidationRequestsWithHttpInfoAsync(int, CancellationToken)

Delete all validation requests

Declaration
Task<ApiResponse<object>> DeleteAllValidationRequestsWithHttpInfoAsync(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<object>>

Task of ApiResponse
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteValidationRequestAsync(Guid, int, CancellationToken)

Delete a validation record

Declaration
Task DeleteValidationRequestAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task

Task of void
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteValidationRequestWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a validation record

Declaration
Task<ApiResponse<object>> DeleteValidationRequestWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<object>>

Task of ApiResponse
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetValidationRequestsAsync(int?, int?, string, string, DateTime?, DateTime?, bool?, int, CancellationToken)

Validate a list of email addresses. Per unit billing. See your plan for pricing.

Declaration
Task<PageEmailValidationRequest> GetValidationRequestsAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? isValid = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

Optional page size for paginated result list. (optional, default to 20)
string sort

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
bool? isValid

Filter where email is valid is true or false (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<PageEmailValidationRequest>

Task of PageEmailValidationRequest
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetValidationRequestsWithHttpInfoAsync(int?, int?, string, string, DateTime?, DateTime?, bool?, int, CancellationToken)

Validate a list of email addresses. Per unit billing. See your plan for pricing.

Declaration
Task<ApiResponse<PageEmailValidationRequest>> GetValidationRequestsWithHttpInfoAsync(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? isValid = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int? page

Optional page index in list pagination (optional, default to 0)
int? size

Optional page size for paginated result list. (optional, default to 20)
string sort

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

Optional search filter (optional)
DateTime? since

Filter by created at after the given timestamp (optional)
DateTime? before

Filter by created at before the given timestamp (optional)
bool? isValid

Filter where email is valid is true or false (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<PageEmailValidationRequest>>

Task of ApiResponse (PageEmailValidationRequest)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidateEmailAddressListAsync(ValidateEmailAddressListOptions, int, CancellationToken)

Validate a list of email addresses. Per unit billing. See your plan for pricing.

Declaration
Task<ValidateEmailAddressListResult> ValidateEmailAddressListAsync(ValidateEmailAddressListOptions validateEmailAddressListOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ValidateEmailAddressListOptions validateEmailAddressListOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ValidateEmailAddressListResult>

Task of ValidateEmailAddressListResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidateEmailAddressListWithHttpInfoAsync(ValidateEmailAddressListOptions, int, CancellationToken)

Validate a list of email addresses. Per unit billing. See your plan for pricing.

Declaration
Task<ApiResponse<ValidateEmailAddressListResult>> ValidateEmailAddressListWithHttpInfoAsync(ValidateEmailAddressListOptions validateEmailAddressListOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ValidateEmailAddressListOptions validateEmailAddressListOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<ValidateEmailAddressListResult>>

Task of ApiResponse (ValidateEmailAddressListResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call