mailboxvalidator-nodejs
Advanced tools
This Node.js module provides an easy way to call the MailboxValidator API which validates if an email address is a valid one.
This module can be used in many types of projects such as:
To install this module type the following:
npm install mailboxvalidator-nodejs
An api key is required for this module to function.
Go to https://www.mailboxvalidator.com/plans#api to sign up for FREE API plan and you'll be given an API key.
var mbv = require("mailboxvalidator-nodejs");
mbv.MailboxValidator_init("YOUR_API_KEY");
mbv.MailboxValidator_single_query("example@example.com", mbv_read_single);
function mbv_read_single(err, res, data) {
if (!err && res.statusCode == 200) {
console.log("email_address: " + data.email_address);
console.log("domain: " + data.domain);
console.log("is_free: " + data.is_free);
console.log("is_syntax: " + data.is_syntax);
console.log("is_domain: " + data.is_domain);
console.log("is_smtp: " + data.is_smtp);
console.log("is_verified: " + data.is_verified);
console.log("is_server_down: " + data.is_server_down);
console.log("is_greylisted: " + data.is_greylisted);
console.log("is_disposable: " + data.is_disposable);
console.log("is_suppressed: " + data.is_suppressed);
console.log("is_role: " + data.is_role);
console.log("is_high_risk: " + data.is_high_risk);
console.log("is_catchall: " + data.is_catchall);
console.log("mailboxvalidator_score: " + data.mailboxvalidator_score);
console.log("time_taken: " + data.time_taken);
console.log("status: " + data.status);
console.log("credits_available: " + data.credits_available);
console.log("error_code: " + data.error_code);
console.log("error_message: " + data.error_message);
}
}
Creates a new instance of the MailboxValidator object with the API key.
Performs email validation on the supplied email address and a callback function.
The input email address.
The domain of the email address.
Whether the email address is from a free email provider like Gmail or Hotmail.
Return values: True, False
Whether the email address is syntactically correct.
Return values: True, False
Whether the email address has a valid MX record in its DNS entries.
Return values: True, False, - (- means not applicable)
Whether the mail servers specified in the MX records are responding to connections.
Return values: True, False, - (- means not applicable)
Whether the mail server confirms that the email address actually exist.
Return values: True, False, - (- means not applicable)
Whether the mail server is currently down or unresponsive.
Return values: True, False, - (- means not applicable)
Whether the mail server employs greylisting where an email has to be sent a second time at a later time.
Return values: True, False, - (- means not applicable)
Whether the email address is a temporary one from a disposable email provider.
Return values: True, False, - (- means not applicable)
Whether the email address is in our blacklist.
Return values: True, False, - (- means not applicable)
Whether the email address is a role-based email address like admin@example.net or webmaster@example.net.
Return values: True, False, - (- means not applicable)
Whether the email address contains high risk keywords.
Return values: True, False, - (- means not applicable)
Whether the email address is a catch-all address.
Return values: True, False, Unknown, - (- means not applicable)
Email address reputation score.
Score > 0.70 means good; score > 0.40 means fair; score <= 0.40 means poor.
The time taken to get the results in seconds.
Whether our system think the email address is valid based on all the previous fields.
Return values: True, False
The number of credits left to perform validations.
The error code if there is any error. See error table below.
The error message if there is any error. See error table below.
var mbv = require("mailboxvalidator-nodejs");
mbv.MailboxValidator_init("YOUR_API_KEY");
mbv.MailboxValidator_disposable_email("example@example.com", mbv_read_disposable);
function mbv_read_disposable(err, res, data) {
if (!err && res.statusCode == 200) {
console.log("email_address: " + data.email_address);
console.log("is_disposable: " + data.is_disposable);
console.log("credits_available: " + data.credits_available);
console.log("error_code: " + data.error_code);
console.log("error_message: " + data.error_message);
}
}
Creates a new instance of the MailboxValidator object with the API key.
Performs disposable email check on the supplied email address and a callback function.
The input email address.
Whether the email address is a temporary one from a disposable email provider.
Return values: True, False
The number of credits left to perform validations.
The error code if there is any error. See error table below.
The error message if there is any error. See error table below.
var mbv = require("mailboxvalidator-nodejs");
mbv.MailboxValidator_init("YOUR_API_KEY");
mbv.MailboxValidator_free_email("example@example.com", mbv_read_free);
function mbv_read_free(err, res, data) {
if (!err && res.statusCode == 200) {
console.log("email_address: " + data.email_address);
console.log("is_free: " + data.is_free);
console.log("credits_available: " + data.credits_available);
console.log("error_code: " + data.error_code);
console.log("error_message: " + data.error_message);
}
}
Creates a new instance of the MailboxValidator object with the API key.
Performs free email check on the supplied email address and a callback function.
The input email address.
Whether the email address is from a free email provider like Gmail or Hotmail.
Return values: True, False
The number of credits left to perform validations.
The error code if there is any error. See error table below.
The error message if there is any error. See error table below.
| error_code | error_message |
|---|---|
| 100 | Missing parameter. |
| 101 | API key not found. |
| 102 | API key disabled. |
| 103 | API key expired. |
| 104 | Insufficient credits. |
| 105 | Unknown error. |
Copyright (C) 2018 by MailboxValidator.com, support@mailboxvalidator.com
FAQs
MailboxValidator Node.js module enable users to block disposal email, detect free email and validate if an email is valid
The npm package mailboxvalidator-nodejs receives a total of 6 weekly downloads. As such, mailboxvalidator-nodejs popularity was classified as not popular.
We found that mailboxvalidator-nodejs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.