g}" />
$ curl -s -i -X GET 'https://api.mailvalidator.io/validatemail?mailaddress=<testEmail@address.com>&apiKey=<yourAPIkey>'
{
"success": <true|false>,
"mailToValidate":
{
"mailAddress": "<testEmail@address.com>",
"validAddress": "<VALID|INVALID|CANNOT_VERIFY>"
}
|
"exception": "<corresponding error message>"
}
{
"success": true,
"mailToValidate":
{
"mailAddress": "testEmail@address.com",
"validAddress": "VALID"
}
}
{
"success": false,
"exception":
{
"simpleName": "InvalidApiKeyException",
"message": "The given API KEY: <123456789> is invalid!"
}
}
{
"success": false,
"exception":
{
"simpleName": "UnauthorizedException",
"message": "Invalid API KEY: <123456789> OR no credit left OR too much requests for this IP ADDRESS: 0:0:0:0:0:0:0:1"
}
}
The Batch validation is an Asynchronous process:
1. Submit all email addresses you want to verify and you get a Queue URL
2a. Query the Queue URL and get the Result URL
2b. Once is done when you query the Queue URL you get the Result URL
3. Query the Result URL to get the validation result
$ curl -s -i -X POST -H "Content-Type: application/json" -d
'{
"mailAddresses" : [ "<yourmail1@address.com>", "<yourmail2@address.com>", "<yourmail3@address.com>" ],
"apiKey" : "<yourAPIkey>"
}'
'https://api.mailvalidator.io/validatemails'
HTTP/1.1 201
Location: https://api.mailvalidator.io/queue/<queueId>
HTTP/1.1 400
{
"success": false,
"exception":
{
"simpleName": "<Exception Name>",
"message": "<Exception Description>"
}
}
$ curl -s -i -X GET 'https://api.mailvalidator.io/queue/<queueId>'
HTTP/1.1 200
{
"status": "PENDING"
}
HTTP/1.1 303
Location: https://api.mailvalidator.io/results/<resultId>
HTTP/1.1 400
Connection: close
$ curl -s -i -X GET 'https://api.mailvalidator.io/results/<resultId>'
HTTP/1.1 200
[
{
"mailAddress": "<yourmail1@address.com>",
"validAddress": "<VALID|INVALID|CANNOT_VERIFY>"
},
{
"mailAddress": "<yourmail2@address.com>",
"validAddress": "<VALID|INVALID|CANNOT_VERIFY>"
},
{
"mailAddress": "<yourmail3@address.com>",
"validAddress": "<VALID|INVALID|CANNOT_VERIFY>"
}
]
HTTP/1.1 400
Connection: close