com.mailslurp.apis

Class EmailVerificationControllerApi

java.lang.Object

com.mailslurp.apis.EmailVerificationControllerApi

public class EmailVerificationControllerApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EmailVerificationControllerApi()
EmailVerificationControllerApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
PageEmailValidationRequest	getValidationRequests(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean isValid) Validate a list of email addresses.
okhttp3.Call	getValidationRequestsAsync(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean isValid, ApiCallback<PageEmailValidationRequest> _callback) Validate a list of email addresses.
okhttp3.Call	getValidationRequestsCall(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean isValid, ApiCallback _callback) Build call for getValidationRequests
ApiResponse<PageEmailValidationRequest>	getValidationRequestsWithHttpInfo(Integer page, Integer size, String sort, String searchFilter, OffsetDateTime since, OffsetDateTime before, Boolean isValid) Validate a list of email addresses.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
ValidateEmailAddressListResult	validateEmailAddressList(ValidateEmailAddressListOptions validateEmailAddressListOptions) Validate a list of email addresses.
okhttp3.Call	validateEmailAddressListAsync(ValidateEmailAddressListOptions validateEmailAddressListOptions, ApiCallback<ValidateEmailAddressListResult> _callback) Validate a list of email addresses.
okhttp3.Call	validateEmailAddressListCall(ValidateEmailAddressListOptions validateEmailAddressListOptions, ApiCallback _callback) Build call for validateEmailAddressList
ApiResponse<ValidateEmailAddressListResult>	validateEmailAddressListWithHttpInfo(ValidateEmailAddressListOptions validateEmailAddressListOptions) Validate a list of email addresses.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmailVerificationControllerApi

public EmailVerificationControllerApi()

EmailVerificationControllerApi

public EmailVerificationControllerApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

getValidationRequestsCall

public okhttp3.Call getValidationRequestsCall(Integer page,
                                              Integer size,
                                              String sort,
                                              String searchFilter,
                                              OffsetDateTime since,
                                              OffsetDateTime before,
                                              Boolean isValid,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for getValidationRequests

Parameters:

page - Optional page index in list pagination (optional, default to 0)

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

isValid - Filter where email is valid is true or false (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getValidationRequests

public PageEmailValidationRequest getValidationRequests(Integer page,
                                                        Integer size,
                                                        String sort,
                                                        String searchFilter,
                                                        OffsetDateTime since,
                                                        OffsetDateTime before,
                                                        Boolean isValid)
                                                 throws ApiException

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

Parameters:

page - Optional page index in list pagination (optional, default to 0)

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

isValid - Filter where email is valid is true or false (optional)

Returns:

PageEmailValidationRequest

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getValidationRequestsWithHttpInfo

public ApiResponse<PageEmailValidationRequest> getValidationRequestsWithHttpInfo(Integer page,
                                                                                 Integer size,
                                                                                 String sort,
                                                                                 String searchFilter,
                                                                                 OffsetDateTime since,
                                                                                 OffsetDateTime before,
                                                                                 Boolean isValid)
                                                                          throws ApiException

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

Parameters:

page - Optional page index in list pagination (optional, default to 0)

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

isValid - Filter where email is valid is true or false (optional)

Returns:

ApiResponse<PageEmailValidationRequest>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

getValidationRequestsAsync

public okhttp3.Call getValidationRequestsAsync(Integer page,
                                               Integer size,
                                               String sort,
                                               String searchFilter,
                                               OffsetDateTime since,
                                               OffsetDateTime before,
                                               Boolean isValid,
                                               ApiCallback<PageEmailValidationRequest> _callback)
                                        throws ApiException

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

Parameters:

page - Optional page index in list pagination (optional, default to 0)

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

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

searchFilter - Optional search filter (optional)

since - Filter by created at after the given timestamp (optional)

before - Filter by created at before the given timestamp (optional)

isValid - Filter where email is valid is true or false (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

validateEmailAddressListCall

public okhttp3.Call validateEmailAddressListCall(ValidateEmailAddressListOptions validateEmailAddressListOptions,
                                                 ApiCallback _callback)
                                          throws ApiException

Build call for validateEmailAddressList

Parameters:

validateEmailAddressListOptions - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

validateEmailAddressList

public ValidateEmailAddressListResult validateEmailAddressList(ValidateEmailAddressListOptions validateEmailAddressListOptions)
                                                        throws ApiException

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

Parameters:

validateEmailAddressListOptions - (required)

Returns:

ValidateEmailAddressListResult

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

validateEmailAddressListWithHttpInfo

public ApiResponse<ValidateEmailAddressListResult> validateEmailAddressListWithHttpInfo(ValidateEmailAddressListOptions validateEmailAddressListOptions)
                                                                                 throws ApiException

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

Parameters:

validateEmailAddressListOptions - (required)

Returns:

ApiResponse<ValidateEmailAddressListResult>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-

validateEmailAddressListAsync

public okhttp3.Call validateEmailAddressListAsync(ValidateEmailAddressListOptions validateEmailAddressListOptions,
                                                  ApiCallback<ValidateEmailAddressListResult> _callback)
                                           throws ApiException

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

Parameters:

validateEmailAddressListOptions - (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-