Updated to call MailboxValidator v2 APIs

Author: MailboxValidator

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 MailboxValidator.com
+Copyright (c) 2023 MailboxValidator.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -30,36 +30,33 @@ Usage for validation email
 ==========================
 
 ```javascript
-var mbv = require("mailboxvalidator-nodejs");
+let mbv = require("mailboxvalidator-nodejs");
 
 mbv.MailboxValidator_init("YOUR_API_KEY");
 
-mbv.MailboxValidator_single_query("[email protected]", 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);
-	}
-}
+mbv.MailboxValidator_single_query("[email protected]")
+.then((data) => {
+	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);})
+.catch((error) => {
+	console.log(error)
+});
 ```
 
 Functions
@@ -69,9 +66,9 @@ Functions
 
 Creates a new instance of the MailboxValidator object with the API key.
 
-### MailboxValidator_single_query(email_address, callback_function)
+### MailboxValidator_single_query(email_address)
 
-Performs email validation on the supplied email address and a callback function.
+Performs email validation on the supplied email address and returns a Promise.
 
 Result Fields
 =============
@@ -88,73 +85,73 @@ The domain of the email address.
 
 Whether the email address is from a free email provider like Gmail or Hotmail.
 
-Return values: True, False
+Return values: true, false
 
 ### is_syntax
 
 Whether the email address is syntactically correct.
 
-Return values: True, False
+Return values: true, false
 
 ### is_domain
 
 Whether the email address has a valid MX record in its DNS entries.
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_smtp
 
 Whether the mail servers specified in the MX records are responding to connections.
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_verified
 
 Whether the mail server confirms that the email address actually exist.
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_server_down
 
 Whether the mail server is currently down or unresponsive.
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_greylisted
 
 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)
+Return values: true, false, null   (null means not applicable)
 
 ### is_disposable
 
 Whether the email address is a temporary one from a disposable email provider.
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_suppressed
 
 Whether the email address is in our blacklist.
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_role
 
 Whether the email address is a role-based email address like [email protected] or [email protected].
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_high_risk
 
 Whether the email address contains high risk keywords.
 
-Return values: True, False, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### is_catchall
 
 Whether the email address is a catch-all address.
 
-Return values: True, False, Unknown, -   (- means not applicable)
+Return values: true, false, null   (null means not applicable)
 
 ### mailboxvalidator_score
 
@@ -170,40 +167,29 @@ 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
+Return values: true, false
 
 ### credits_available
 
 The number of credits left to perform validations.
 
-### error_code
-
-The error code if there is any error. See error table below.
-
-### error_message
-
-The error message if there is any error. See error table below.
-
-
 Usage for checking if the email is from a disposable email provider
 ===================================================================
 
 ```javascript
-var mbv = require("mailboxvalidator-nodejs");
+let mbv = require("mailboxvalidator-nodejs");
 
 mbv.MailboxValidator_init("YOUR_API_KEY");
 
-mbv.MailboxValidator_disposable_email("[email protected]", 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);
-	}
-}
+mbv.MailboxValidator_disposable_email("[email protected]")
+.then((data) => {
+	console.log("email_address: " + data.email_address);
+	console.log("is_disposable: " + data.is_disposable);
+	console.log("credits_available: " + data.credits_available);
+})
+.catch((error) => {
+	console.log(error)
+});
 ```
 
 Functions
@@ -213,9 +199,9 @@ Functions
 
 Creates a new instance of the MailboxValidator object with the API key.
 
-### MailboxValidator_disposable_email(email_address, callback_function)
+### MailboxValidator_disposable_email(email_address)
 
-Performs disposable email check on the supplied email address and a callback function.
+Performs disposable email check on the supplied email address and returns a Promise.
 
 Result Fields
 =============
@@ -228,40 +214,28 @@ The input email address.
 
 Whether the email address is a temporary one from a disposable email provider.
 
-Return values: True, False
+Return values: true, false
 
 ### credits_available
 
 The number of credits left to perform validations.
 
-### error_code
-
-The error code if there is any error. See error table below.
-
-### error_message
-
-The error message if there is any error. See error table below.
-
-
 Usage for checking if the email is from a free email provider
 =============================================================
 
 ```javascript
-var mbv = require("mailboxvalidator-nodejs");
+let mbv = require("mailboxvalidator-nodejs");
 
 mbv.MailboxValidator_init("YOUR_API_KEY");
 
-mbv.MailboxValidator_free_email("[email protected]", 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);
-	}
-}
+mbv.MailboxValidator_free_email("[email protected]")
+.then((data) => {
+	console.log("email_address: " + data.email_address);
+	console.log("is_free: " + data.is_free);
+	console.log("credits_available: " + data.credits_available);})
+.catch((error) => {
+	console.log(error)
+});
 ```
 
 Functions
@@ -271,9 +245,9 @@ Functions
 
 Creates a new instance of the MailboxValidator object with the API key.
 
-### MailboxValidator_free_email(email_address, callback_function)
+### MailboxValidator_free_email(email_address)
 
-Performs free email check on the supplied email address and a callback function.
+Performs free email check on the supplied email address and returns a Promise.
 
 Result Fields
 =============
@@ -286,35 +260,14 @@ The input email address.
 
 Whether the email address is from a free email provider like Gmail or Hotmail.
 
-Return values: True, False
+Return values: true, false
 
 ### credits_available
 
 The number of credits left to perform validations.
 
-### error_code
-
-The error code if there is any error. See error table below.
-
-### error_message
-
-The error message if there is any error. See error table below.
-
-
-Errors
-======
-
-| 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
 =========
 
-Copyright (C) 2020 by MailboxValidator.com, [email protected]
+Copyright (C) 2023 by MailboxValidator.com, [email protected]

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "mailboxvalidator-nodejs",
-	"version": "1.1.3",
+	"version": "2.0.0",
 	"description": "MailboxValidator Node.js module enable users to block disposal email, detect free email and validate if an email is valid",
 	"keywords": ["email validation", "disposable", "invalid email", "free email", "fake email"],
 	"homepage": "https://www.mailboxvalidator.com/nodejs",