Interface IEmailVerificationControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IEmailVerificationControllerApiSync : IApiAccessor

Methods

View Source

DeleteAllValidationRequests(int)

Delete all validation requests

Declaration

void DeleteAllValidationRequests(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Remarks

Remove validation requests

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteAllValidationRequestsWithHttpInfo(int)

Delete all validation requests

Declaration

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)

Remarks

Remove validation requests

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteValidationRequest(Guid, int)

Delete a validation record

Declaration

void DeleteValidationRequest(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	id
int	operationIndex	Index associated with the operation.

Remarks

Delete a validation record

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteValidationRequestWithHttpInfo(Guid, int)

Delete a validation record

Declaration

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)

Remarks

Delete a validation record

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

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.

Declaration

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

Remarks

List email verification requests

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.

Declaration

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

Remarks

List email verification requests

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.

Declaration

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

Remarks

Verify a list of email addresses is valid and can be contacted.

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.

Declaration

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

Remarks

Verify a list of email addresses is valid and can be contacted.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call