quickemailverification
v1.0.4
Published
Official QuickEmailVerification API library client for node.js
Downloads
2,118
Maintainers
Readme
Official Email Validation API library client for Node.js
QuickEmailVerification provides the quickest way to avoid fake / invalid emails.
- Get actual users by scanning email address.
- Remove invalid, dead and fake emails from your email list.
- Save time and money by sending mail to actual users.
Let's Get Started
To begin, signUp at quickemailverification.com and create a FREE account. After signup logged in, click on API Settings and then click Add API Key. To use API you need 2 parameters.
email - (string) This is a email address you need to verify. It should be url encoded.
apikey - (string) This is the key you generated from "api settings" page.
NOTE: Keep API key with you. - you'll need it to setup the client as explained below.
Installation
Make sure you have npm installed.
$ npm install quickemailverification
Versions
Works with [ 0.8 / 0.9 / 0.10 / 0.11 ]
Usage
var quickemailverification = require('quickemailverification').client('Your_API_Key_Here').quickemailverification();
// PRODUCTION MODE
quickemailverification.verify("[email protected]", function (err, response) {
// SANDBOX MODE
//quickemailverification.sandbox("[email protected]", function (err, response) {
// Print response object
console.log(response.body);
});
Response information
A successful API call responds with the following values:
result
string
- The verified results will be:valid
,invalid
,unknown
reason
string
- Reason definitions are as below:invalid_email
- Specified email has invalid email address syntaxinvalid_domain
- Domain name does not existrejected_email
- SMTP server rejected email. Email does not existaccepted_email
- SMTP server accepted email addressno_connect
- SMTP server connection failuretimeout
- Session time out occurred at SMTP serverunavailable_smtp
- SMTP server is not available to process requestunexpected_error
- An unexpected error has occurredno_mx_record
- Could not get MX records for domaintemporarily_blocked
- Email is temporarily greylistedexceeded_storage
- SMTP server rejected email. Exceeded storage allocation
disposable
true | false
- true if the email address uses a disposable domainaccept_all
true | false
- true if the domain appears to accept all emails delivered to that domainrole
true | false
- true if the email address is a role address ([email protected]
,[email protected]
, etc)free
true | false
- true if the email address is from free email provider like Gmail, Yahoo!, Hotmail etc.email
string
- Returns a normalized version. ([email protected]
->[email protected]
user
string
- The local part of an email address. ([email protected]
->niki
)domain
string
- The domain of the provided email address. ([email protected]
->example.com
)mx_record
string
- The preferred MX record of email domain. This field contains empty string when MX record is not available.mx_domain
string
- The domain name of the MX host. This field contains empty string when MX record is not available.safe_to_send
true | false
- true if the email address is safe for deliverabilitydid_you_mean
string
- Returns email suggestions if specific typo errors found in emailsuccess
true | false
- true if the API request was successfulmessage
string
- Describes API call failure reason
HTTP Response headers
Total remaining credits can be found by http response header. It contains overall remaining credits, including Persistent & Per day credits.
- X-QEV-Remaining-Credits - Your remaining email verification credits (i.e. Per Day credits + Persistent Credits).
HTTP status codes for QuickEmailVerification API calls
QuickEmailVerification API also returns following HTTP status codes to indicate success or failure of request.
200
- Request is completed successfully400
- Server can not understand the request sent to it. This is kind of response can occur if parameters are passed wrongly.401
- Server can not verify your authentication to use api. Please check whether API key is proper or not.402
- You are running out of your credit limit.404
- Requested API can not be found on server.429
- Too many requests. Rate limit exceeded.
Sandbox Mode
QuickEmailVerification single email verification API sandbox mode helps developers to test their integration against simulated results. Requesting against sandbox endpoint is totally free and no credits will be deducted from actual credit quota.
Please refer our knowledge base to learn more about sandbox mode.
License
MIT
Bug Reports
Report here.
Need Help? Feel free to contact us
https://quickemailverification.com/contact-us