Class EmailVerificationControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance
object
EmailVerificationControllerApi
Implements
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class EmailVerificationControllerApi : IEmailVerificationControllerApi, IEmailVerificationControllerApiSync, IEmailVerificationControllerApiAsync, IApiAccessor

Constructors

View Source

EmailVerificationControllerApi()

Initializes a new instance of the EmailVerificationControllerApi class.

Declaration
public EmailVerificationControllerApi()
View Source

EmailVerificationControllerApi(string)

Initializes a new instance of the EmailVerificationControllerApi class.

Declaration
public EmailVerificationControllerApi(string basePath)
Parameters
Type Name Description
string basePath
View Source

EmailVerificationControllerApi(Configuration)

Initializes a new instance of the EmailVerificationControllerApi class using Configuration object

Declaration
public EmailVerificationControllerApi(Configuration configuration)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration
View Source

EmailVerificationControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration
public EmailVerificationControllerApi(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.

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

DeleteAllValidationRequests(int)

Delete all validation requests Remove validation requests

Declaration
public void DeleteAllValidationRequests(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllValidationRequestsAsync(int, CancellationToken)

Delete all validation requests Remove validation requests

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

DeleteAllValidationRequestsWithHttpInfo(int)

Delete all validation requests Remove validation requests

Declaration
public ApiResponse<object> DeleteAllValidationRequestsWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteAllValidationRequestsWithHttpInfoAsync(int, CancellationToken)

Delete all validation requests Remove validation requests

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

DeleteValidationRequest(Guid, int)

Delete a validation record Delete a validation record

Declaration
public void DeleteValidationRequest(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteValidationRequestAsync(Guid, int, CancellationToken)

Delete a validation record Delete a validation record

Declaration
public Task DeleteValidationRequestAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
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

DeleteValidationRequestWithHttpInfo(Guid, int)

Delete a validation record Delete a validation record

Declaration
public ApiResponse<object> DeleteValidationRequestWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteValidationRequestWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a validation record Delete a validation record

Declaration
public Task<ApiResponse<object>> DeleteValidationRequestWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
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

GetBasePath()

Gets the base path of the API client.

Declaration
public string GetBasePath()
Returns
Type Description
string

The base path
View Source

GetValidationRequests(int?, int?, string, string, DateTime?, DateTime?, bool?, int)

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

Declaration
public PageEmailValidationRequest GetValidationRequests(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? isValid = null, int operationIndex = 0)
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.
Returns
Type Description
PageEmailValidationRequest

PageEmailValidationRequest
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. List email verification requests

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

GetValidationRequestsWithHttpInfo(int?, int?, string, string, DateTime?, DateTime?, bool?, int)

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

Declaration
public ApiResponse<PageEmailValidationRequest> GetValidationRequestsWithHttpInfo(int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, bool? isValid = null, int operationIndex = 0)
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.
Returns
Type Description
ApiResponse<PageEmailValidationRequest>

ApiResponse 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. List email verification requests

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

ValidateEmailAddressList(ValidateEmailAddressListOptions, int)

Validate a list of email addresses. Per unit billing. See your plan for pricing. Verify a list of email addresses is valid and can be contacted.

Declaration
public ValidateEmailAddressListResult ValidateEmailAddressList(ValidateEmailAddressListOptions validateEmailAddressListOptions, int operationIndex = 0)
Parameters
Type Name Description
ValidateEmailAddressListOptions validateEmailAddressListOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ValidateEmailAddressListResult

ValidateEmailAddressListResult
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. Verify a list of email addresses is valid and can be contacted.

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

ValidateEmailAddressListWithHttpInfo(ValidateEmailAddressListOptions, int)

Validate a list of email addresses. Per unit billing. See your plan for pricing. Verify a list of email addresses is valid and can be contacted.

Declaration
public ApiResponse<ValidateEmailAddressListResult> ValidateEmailAddressListWithHttpInfo(ValidateEmailAddressListOptions validateEmailAddressListOptions, int operationIndex = 0)
Parameters
Type Name Description
ValidateEmailAddressListOptions validateEmailAddressListOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ValidateEmailAddressListResult>

ApiResponse 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. Verify a list of email addresses is valid and can be contacted.

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

Implements