Official QuickEmailVerification 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();
quickemailverification.verify("test@example.com", function (err, response) {
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 definations 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 occured 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 graylistedexceeded_storage
- SMTP server rejected email. Exceeded storage allocation
-
role true | false
- true if the email address is a role address (manager@example.com
, ceo@example.com
, etc)
-
email string
- Returns a normalized version. (Niki@example.com
-> niki@example.com
-
user string
- The local part of an email address. (niki@example.com
-> niki
)
-
domain string
- The domain of the provided email address. (niki@example.com
-> example.com
)
-
success true | false
- true if the API request was successful
-
message string
- Describes API call failure reason
-
disposable true | false
- true if the email address uses a disposable domain.
-
accept_all true | false
- true if the domain appears to accept all emails delivered to that domain
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.
License
MIT
Bug Reports
Report here.
Need Help? Feel free to contact us
http://quickemailverification.com/contact-us