EmailVerificationControllerApi
in package
EmailVerificationControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['deleteAllValidationRequests' => ['application/json'], 'deleteValidationRequest' => ['application/json'], 'getValidationRequests' => ['application/json'], 'validateEmailAddressList' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- deleteAllValidationRequests() : void
- Operation deleteAllValidationRequests
- deleteAllValidationRequestsAsync() : PromiseInterface
- Operation deleteAllValidationRequestsAsync
- deleteAllValidationRequestsAsyncWithHttpInfo() : PromiseInterface
- Operation deleteAllValidationRequestsAsyncWithHttpInfo
- deleteAllValidationRequestsRequest() : Request
- Create request for operation 'deleteAllValidationRequests'
- deleteAllValidationRequestsWithHttpInfo() : array<string|int, mixed>
- Operation deleteAllValidationRequestsWithHttpInfo
- deleteValidationRequest() : void
- Operation deleteValidationRequest
- deleteValidationRequestAsync() : PromiseInterface
- Operation deleteValidationRequestAsync
- deleteValidationRequestAsyncWithHttpInfo() : PromiseInterface
- Operation deleteValidationRequestAsyncWithHttpInfo
- deleteValidationRequestRequest() : Request
- Create request for operation 'deleteValidationRequest'
- deleteValidationRequestWithHttpInfo() : array<string|int, mixed>
- Operation deleteValidationRequestWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getValidationRequests() : PageEmailValidationRequest
- Operation getValidationRequests
- getValidationRequestsAsync() : PromiseInterface
- Operation getValidationRequestsAsync
- getValidationRequestsAsyncWithHttpInfo() : PromiseInterface
- Operation getValidationRequestsAsyncWithHttpInfo
- getValidationRequestsRequest() : Request
- Create request for operation 'getValidationRequests'
- getValidationRequestsWithHttpInfo() : array<string|int, mixed>
- Operation getValidationRequestsWithHttpInfo
- setHostIndex() : void
- Set the host index
- validateEmailAddressList() : ValidateEmailAddressListResult
- Operation validateEmailAddressList
- validateEmailAddressListAsync() : PromiseInterface
- Operation validateEmailAddressListAsync
- validateEmailAddressListAsyncWithHttpInfo() : PromiseInterface
- Operation validateEmailAddressListAsyncWithHttpInfo
- validateEmailAddressListRequest() : Request
- Create request for operation 'validateEmailAddressList'
- validateEmailAddressListWithHttpInfo() : array<string|int, mixed>
- Operation validateEmailAddressListWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['deleteAllValidationRequests' => ['application/json'], 'deleteValidationRequest' => ['application/json'], 'getValidationRequests' => ['application/json'], 'validateEmailAddressList' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —deleteAllValidationRequests()
Operation deleteAllValidationRequests
public
deleteAllValidationRequests([string $contentType = self::contentTypes['deleteAllValidationRequests'][0] ]) : void
Delete all validation requests
Parameters
- $contentType : string = self::contentTypes['deleteAllValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllValidationRequests'] to see the possible values for this operation
Tags
Return values
void —deleteAllValidationRequestsAsync()
Operation deleteAllValidationRequestsAsync
public
deleteAllValidationRequestsAsync([string $contentType = self::contentTypes['deleteAllValidationRequests'][0] ]) : PromiseInterface
Delete all validation requests
Parameters
- $contentType : string = self::contentTypes['deleteAllValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllValidationRequests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllValidationRequestsAsyncWithHttpInfo()
Operation deleteAllValidationRequestsAsyncWithHttpInfo
public
deleteAllValidationRequestsAsyncWithHttpInfo([string $contentType = self::contentTypes['deleteAllValidationRequests'][0] ]) : PromiseInterface
Delete all validation requests
Parameters
- $contentType : string = self::contentTypes['deleteAllValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllValidationRequests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteAllValidationRequestsRequest()
Create request for operation 'deleteAllValidationRequests'
public
deleteAllValidationRequestsRequest([string $contentType = self::contentTypes['deleteAllValidationRequests'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['deleteAllValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllValidationRequests'] to see the possible values for this operation
Tags
Return values
Request —deleteAllValidationRequestsWithHttpInfo()
Operation deleteAllValidationRequestsWithHttpInfo
public
deleteAllValidationRequestsWithHttpInfo([string $contentType = self::contentTypes['deleteAllValidationRequests'][0] ]) : array<string|int, mixed>
Delete all validation requests
Parameters
- $contentType : string = self::contentTypes['deleteAllValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteAllValidationRequests'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteValidationRequest()
Operation deleteValidationRequest
public
deleteValidationRequest(string $id[, string $contentType = self::contentTypes['deleteValidationRequest'][0] ]) : void
Delete a validation record
Parameters
- $id : string
-
id (required)
- $contentType : string = self::contentTypes['deleteValidationRequest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteValidationRequest'] to see the possible values for this operation
Tags
Return values
void —deleteValidationRequestAsync()
Operation deleteValidationRequestAsync
public
deleteValidationRequestAsync(string $id[, string $contentType = self::contentTypes['deleteValidationRequest'][0] ]) : PromiseInterface
Delete a validation record
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteValidationRequest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteValidationRequest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteValidationRequestAsyncWithHttpInfo()
Operation deleteValidationRequestAsyncWithHttpInfo
public
deleteValidationRequestAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteValidationRequest'][0] ]) : PromiseInterface
Delete a validation record
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteValidationRequest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteValidationRequest'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteValidationRequestRequest()
Create request for operation 'deleteValidationRequest'
public
deleteValidationRequestRequest(string $id[, string $contentType = self::contentTypes['deleteValidationRequest'][0] ]) : Request
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteValidationRequest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteValidationRequest'] to see the possible values for this operation
Tags
Return values
Request —deleteValidationRequestWithHttpInfo()
Operation deleteValidationRequestWithHttpInfo
public
deleteValidationRequestWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteValidationRequest'][0] ]) : array<string|int, mixed>
Delete a validation record
Parameters
- $id : string
-
(required)
- $contentType : string = self::contentTypes['deleteValidationRequest'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteValidationRequest'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getValidationRequests()
Operation getValidationRequests
public
getValidationRequests(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $is_valid = null ][, string $contentType = self::contentTypes['getValidationRequests'][0] ]) : PageEmailValidationRequest
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for paginated result list. (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $is_valid : bool = null
-
Filter where email is valid is true or false (optional)
- $contentType : string = self::contentTypes['getValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getValidationRequests'] to see the possible values for this operation
Tags
Return values
PageEmailValidationRequest —getValidationRequestsAsync()
Operation getValidationRequestsAsync
public
getValidationRequestsAsync(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $is_valid = null ][, string $contentType = self::contentTypes['getValidationRequests'][0] ]) : PromiseInterface
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for paginated result list. (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $is_valid : bool = null
-
Filter where email is valid is true or false (optional)
- $contentType : string = self::contentTypes['getValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getValidationRequests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getValidationRequestsAsyncWithHttpInfo()
Operation getValidationRequestsAsyncWithHttpInfo
public
getValidationRequestsAsyncWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $is_valid = null ][, string $contentType = self::contentTypes['getValidationRequests'][0] ]) : PromiseInterface
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for paginated result list. (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $is_valid : bool = null
-
Filter where email is valid is true or false (optional)
- $contentType : string = self::contentTypes['getValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getValidationRequests'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getValidationRequestsRequest()
Create request for operation 'getValidationRequests'
public
getValidationRequestsRequest(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $is_valid = null ][, string $contentType = self::contentTypes['getValidationRequests'][0] ]) : Request
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for paginated result list. (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $is_valid : bool = null
-
Filter where email is valid is true or false (optional)
- $contentType : string = self::contentTypes['getValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getValidationRequests'] to see the possible values for this operation
Tags
Return values
Request —getValidationRequestsWithHttpInfo()
Operation getValidationRequestsWithHttpInfo
public
getValidationRequestsWithHttpInfo(int $page[, int $size = 20 ][, string $sort = 'DESC' ][, string $search_filter = null ][, DateTime $since = null ][, DateTime $before = null ][, bool $is_valid = null ][, string $contentType = self::contentTypes['getValidationRequests'][0] ]) : array<string|int, mixed>
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $page : int
-
Optional page index in list pagination (optional, default to 0)
- $size : int = 20
-
Optional page size for paginated result list. (optional, default to 20)
- $sort : string = 'DESC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'DESC')
- $search_filter : string = null
-
Optional search filter (optional)
- $since : DateTime = null
-
Filter by created at after the given timestamp (optional)
- $before : DateTime = null
-
Filter by created at before the given timestamp (optional)
- $is_valid : bool = null
-
Filter where email is valid is true or false (optional)
- $contentType : string = self::contentTypes['getValidationRequests'][0]
-
The value for the Content-Type header. Check self::contentTypes['getValidationRequests'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageEmailValidationRequest, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —validateEmailAddressList()
Operation validateEmailAddressList
public
validateEmailAddressList(ValidateEmailAddressListOptions $validate_email_address_list_options[, string $contentType = self::contentTypes['validateEmailAddressList'][0] ]) : ValidateEmailAddressListResult
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $validate_email_address_list_options : ValidateEmailAddressListOptions
-
validate_email_address_list_options (required)
- $contentType : string = self::contentTypes['validateEmailAddressList'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateEmailAddressList'] to see the possible values for this operation
Tags
Return values
ValidateEmailAddressListResult —validateEmailAddressListAsync()
Operation validateEmailAddressListAsync
public
validateEmailAddressListAsync(ValidateEmailAddressListOptions $validate_email_address_list_options[, string $contentType = self::contentTypes['validateEmailAddressList'][0] ]) : PromiseInterface
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $validate_email_address_list_options : ValidateEmailAddressListOptions
-
(required)
- $contentType : string = self::contentTypes['validateEmailAddressList'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateEmailAddressList'] to see the possible values for this operation
Tags
Return values
PromiseInterface —validateEmailAddressListAsyncWithHttpInfo()
Operation validateEmailAddressListAsyncWithHttpInfo
public
validateEmailAddressListAsyncWithHttpInfo(ValidateEmailAddressListOptions $validate_email_address_list_options[, string $contentType = self::contentTypes['validateEmailAddressList'][0] ]) : PromiseInterface
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $validate_email_address_list_options : ValidateEmailAddressListOptions
-
(required)
- $contentType : string = self::contentTypes['validateEmailAddressList'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateEmailAddressList'] to see the possible values for this operation
Tags
Return values
PromiseInterface —validateEmailAddressListRequest()
Create request for operation 'validateEmailAddressList'
public
validateEmailAddressListRequest(ValidateEmailAddressListOptions $validate_email_address_list_options[, string $contentType = self::contentTypes['validateEmailAddressList'][0] ]) : Request
Parameters
- $validate_email_address_list_options : ValidateEmailAddressListOptions
-
(required)
- $contentType : string = self::contentTypes['validateEmailAddressList'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateEmailAddressList'] to see the possible values for this operation
Tags
Return values
Request —validateEmailAddressListWithHttpInfo()
Operation validateEmailAddressListWithHttpInfo
public
validateEmailAddressListWithHttpInfo(ValidateEmailAddressListOptions $validate_email_address_list_options[, string $contentType = self::contentTypes['validateEmailAddressList'][0] ]) : array<string|int, mixed>
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Parameters
- $validate_email_address_list_options : ValidateEmailAddressListOptions
-
(required)
- $contentType : string = self::contentTypes['validateEmailAddressList'][0]
-
The value for the Content-Type header. Check self::contentTypes['validateEmailAddressList'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ValidateEmailAddressListResult, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options