dotsemailvalidation3
v1.0.5
Published
DOTS Email Validation 3 (EV3) is a web service that provides validity and metadata information about an email address.
Downloads
3
Maintainers
Readme
Service Objects - Email Validation 3
DOTS Email Validation 3 (EV3) is a web service that provides validity and metadata information about an email address. The service provides common data elements such as syntax validity along with more refined data such as SMTP failures and deliverability flags.
EV3 can help provide instant email data verification to websites or enhancement to contact lists.
Table of Contents
Getting Started
Create a new Node.js project
Install the EV3 module
npm install dotsemailvalidation3
Load in the module to your project
var EmailValidation3 = require(dotsemailvalidation3);
Call the
validateEmailAddress()
methodEmailValidation3.validateEmailAddress( EmailAddress, AllowCorrections, Timeout, LicenseKey, Environment, function(err, response){...} );
ValidateEmailAddress
Inputs
| Parameter | Type | Value | | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | EmailAddress | String | The email address you wish to validate. | | AllowCorrections | String | Accepts true or false. The service will attempt to correct an email address if set to true. Otherwise the email address will be left unaltered if set to false. | | Timeout | String | This value specifies how long the service is allowed to wait for all real-time network level checks to finish. Real-time checks consist primarily of DNS and SMTP level verification. Timeout time is in milliseconds. A minimum value of 200ms is required. | | LicenseKey | String | Your license key to use the service. | | Environment | String | "trial" OR "production" |
Response
{
"ValidateEmailInfo":{
"Score":2147483647,
"IsDeliverable":"String content",
"EmailAddressIn":"String content",
"EmailAddressOut":"String content",
"EmailCorrected":true,
"Box":"String content",
"Domain":"String content",
"TopLevelDomain":"String content",
"TopLevelDomainDescription":"String content",
"IsSMTPServerGood":"String content",
"IsCatchAllDomain":"String content",
"IsSMTPMailBoxGood":"String content",
"WarningCodes":"String content",
"WarningDescriptions":"String content",
"NotesCodes":"String content",
"NotesDescriptions":"String content"
},
"Error":{
"Type":"String content",
"TypeCode":"String content",
"Desc":"String content",
"DescCode":"String content"
},
"Debug":"String content"
}
Features
For trial keys, set the Environment
variable to "trial". Once you purchase a production license key, swap the Environment
variable to "production" and change out your LicenseKey
to your new license key.
The module automatically handles failover logic when using the production environment. This helps to ensure your web service requests are made sucessfully regardless of any network interuptions.
Developer Guide
For a deeper dive into our API, visit our developer guides.
Developer Guide
License Key
If you’re ready to put it to the test, sign up for a free API trial key and get 500 free transactions.
Request a Trial Key