maislurp-client-powershell.maislurp-client-powershell/Api.EmailVerificationControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
Get-ValidationRequests | GET /email-verification/validation-requests | Validate a list of email addresses. Per unit billing. See your plan for pricing. |
Confirm-EmailAddressList | POST /email-verification/email-address-list | Validate a list of email addresses. Per unit billing. See your plan for pricing. |
PageEmailValidationRequest Get-ValidationRequests
[-Page]
[-Size]
[-Sort]
[-SearchFilter]
[-Since]
[-Before]
[-IsValid]
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Example
# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: API_KEY
$Configuration.ApiKey.x-api-key = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.x-api-key = "Bearer"
$Page = 987 # Int32 | Optional page in list pagination (optional) (default to 0)
$Size = 987 # Int32 | Optional page size for paginated result list. (optional) (default to 20)
$Sort = "ASC" # String | Optional createdAt sort direction ASC or DESC (optional) (default to "DESC")
$SearchFilter = "SearchFilter_example" # String | Optional search filter (optional)
$Since = Get-Date # System.DateTime | Filter by created at after the given timestamp (optional)
$Before = Get-Date # System.DateTime | Filter by created at before the given timestamp (optional)
$IsValid = true # Boolean | Filter where email is valid is true or false (optional)
# Validate a list of email addresses. Per unit billing. See your plan for pricing.
try {
$Result = Get-ValidationRequests -Page $Page -Size $Size -Sort $Sort -SearchFilter $SearchFilter -Since $Since -Before $Before -IsValid $IsValid
} catch {
Write-Host ("Exception occured when calling Get-ValidationRequests: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
Page | Int32 | Optional page in list pagination | [optional] [default to 0] |
Size | Int32 | Optional page size for paginated result list. | [optional] [default to 20] |
Sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to "DESC"] |
SearchFilter | String | Optional search filter | [optional] |
Since | System.DateTime | Filter by created at after the given timestamp | [optional] |
Before | System.DateTime | Filter by created at before the given timestamp | [optional] |
IsValid | Boolean | Filter where email is valid is true or false | [optional] |
Return type
PageEmailValidationRequest (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
ValidateEmailAddressListResult Confirm-EmailAddressList
[-ValidateEmailAddressListOptions]
Validate a list of email addresses. Per unit billing. See your plan for pricing.
Example
# general setting of the PowerShell module, e.g. base URL, authentication, etc
$Configuration = Get-Configuration
# Configure API key authorization: API_KEY
$Configuration.ApiKey.x-api-key = "YOUR_API_KEY"
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$Configuration.ApiKeyPrefix.x-api-key = "Bearer"
$ValidateEmailAddressListOptions = (Initialize-ValidateEmailAddressListOptions -EmailAddressList @("EmailAddressList_example")) # ValidateEmailAddressListOptions |
# Validate a list of email addresses. Per unit billing. See your plan for pricing.
try {
$Result = Confirm-EmailAddressList -ValidateEmailAddressListOptions $ValidateEmailAddressListOptions
} catch {
Write-Host ("Exception occured when calling Confirm-EmailAddressList: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
ValidateEmailAddressListOptions | ValidateEmailAddressListOptions |
Return type
ValidateEmailAddressListResult (PSCustomObject)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]