v0.1.0

Author: randoum

.babelrc

@@ -0,0 +1,9 @@
+{
+  "presets": [
+    "@babel/preset-env"
+  ],
+  "plugins": [
+    ["@babel/plugin-proposal-class-properties"],
+    ["@babel/plugin-transform-async-to-generator"]
+  ]
+}

.github/workflows/unittest.yml

@@ -0,0 +1,27 @@
+name: Unit test
+
+on: [push, pull_request]
+
+jobs:
+  unit_test:
+    runs-on: ${{ matrix.operating-system }}
+    strategy:
+      matrix:
+        operating-system: [ ubuntu-18.04, windows-2016 ]
+        node-version: [10.x, 12.x, 14.x, 15.x]
+
+    env:
+      EMAIL_VALIDATION_API_KEY: ${{ secrets.API_KEY }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Run test
+      run: |
+        npm install
+        npm run test

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Abstract
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,123 @@
+# AbstractAPI javascript-email-validation library
+
+Integrate the powerful [email validation API from Abstract](https://www.abstractapi.com/email-verification-validation-api) in your Javascript or NodeJS project in a few lines of code.
+
+Abstract's Email Validation and Verification API is a fast, lightweight, modern, and RESTful JSON API for determining the validity and other details of email addresses.
+
+It's very simple to use: you only need to submit your API key and an email address, and the API will respond an assessment of its validity, as well as additional details like quality score if it's a disposable email, a catchall address, and more.
+
+Validating and verifying email addresses is a critical step to reducing the chances of low-quality data and fraudulent or risky users in your website or application.
+
+# Documentation
+
+## Installation
+
+You can install **javascript-email-validation** via npm, from our CDN, or download the source into your project.
+
+### ES6
+
+Download and install the library from npm:
+
+```
+npm install javascript-email-validation --save
+```
+
+In your project, import it and configure your `API_KEY`:
+
+```js
+import {AbstractEmailValidation} from 'javascript-email-validation'
+
+AbstractEmailValidation.configure('API_KEY')
+```
+
+### Browser, from the built file
+
+You can build the library yourself, or get the already built file from the `dist` directory and load it:
+
+```js
+<script src="dist/javascript-email-validation.js"></script>
+<script>
+    AbstractEmailValidation.configure('API_KEY');
+
+    // use the library
+</script>
+```
+
+## API key
+
+Get your API key for free and without hassle from the [Abstact website](https://app.abstractapi.com/users/signup?target=/api/email-validation/pricing/select).
+
+## Quickstart
+
+AbstractAPI **javascript-email-validation** library returns a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) so you can use one of the following approaches:
+
+### Async/Await
+
+```js
+async function validateEmail(email) {
+  let response = await AbstractEmailValidation.verify(email);
+  console.log(response);
+}
+```
+
+### Using .then()
+
+```js
+function validateEmail(email) {
+  AbstractEmailValidation.verify(email)
+    .then(response => {
+      console.log(response);
+    })
+}
+```
+
+## API response
+
+The API response contains the following fields:
+
+| PARAMETER | TYPE | DETAILS |
+| - | - | - |
+| email | String | The value for "email" that was entered into the request. |
+| auto_correct | String | If a typo has been detected then this parameter returns a suggestion of the correct email (e.g., johnsmith@gmial.com => johnsmith@gmail.com). If no typo is detected then this is empty. |
+| deliverability | String | Abstract's evaluation of the deliverability of the email. Possible values are: DELIVERABLE, UNDELIVERABLE, RISKY, and UNKNOWN |
+| quality_score | Number | An internal decimal score between 0.01 and 0.99 reflecting Abstract's confidence in the quality and deliverability of the submitted email. |
+| is_valid_format | Boolean | Is true if the email follows the format of "address @ domain . TLD". If any of those elements are missing or if they contain extra or incorrect special characters, then it returns false. |
+| is_free_email | Boolean | Is true if the email's domain is found among Abstract's list of free email providers (e.g., Gmail, Yahoo, etc). |
+| is_disposable_email | Boolean | Is true if the email's domain is found among Abstract's list of disposable email providers (e.g., Mailinator, Yopmail, etc). |
+| is_role_email | Boolean | Is true if the email's local part (e.g., the "to" part) appears to be for a role rather than individual. Examples of this include "team@", "sales@", info@", etc. |
+| is_catchall_email | Boolean | Is true if the domain is configured to catch all email. |
+| is_mx_found | Boolean | Is true if MX Records for the domain can be found. Only available on paid plans. Will return null and UNKNOWN on free plans. |
+| is_smtp_valid | Boolean | Is true is the SMTP check of the domain was successful. Only available on paid plans. Will return null and UNKNOWN on free plans. |
+
+## Detailed documentation
+
+You will find additional information and request examples in the [Abstract help page](https://app.abstractapi.com/api/email-validation/documentation).
+
+## Getting help
+
+If you need help installing or using the library, please contact [Abstract's Support](https://app.abstractapi.com/api/email-validation/support).
+
+For bug report and feature suggestion, please use [this repository issues page](https://github.com/abstractapi/javascript-email-validation/issues).
+
+# Contribution
+
+Contributions are always welcome, as they improve the quality of the libraries we provide to the community.
+
+Please provide your changes covered by the appropriate unit tests, and post them in the [pull requests page](https://github.com/abstractapi/javascript-email-validation/pulls).
+
+## NPM
+
+### Installation
+
+Run `npm install` in the command line to install the dependencies. To update those dependencies you need to run `npm update`.
+
+### Building
+
+To build the library and generate the minified file in the *dist* directory, you need to run `npm run build`.
+
+To build the lib, you need to run `npm run build:lib`.
+
+### Test
+
+To run the test suite, you need to run: `npm run test`.
+

dist/javascript-email-validation.js

@@ -0,0 +1 @@
+module.exports = require('./lib/index');

index.js

@@ -0,0 +1,52 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.AbstractEmailValidation = void 0;
+
+var core = _interopRequireWildcard(require("javascript-core"));
+
+function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function _getRequireWildcardCache() { return cache; }; return cache; }
+
+function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var AbstractEmailValidation = function AbstractEmailValidation() {
+  _classCallCheck(this, AbstractEmailValidation);
+};
+
+exports.AbstractEmailValidation = AbstractEmailValidation;
+
+_defineProperty(AbstractEmailValidation, "apiKey", void 0);
+
+_defineProperty(AbstractEmailValidation, "configure", function (apiKey) {
+  AbstractEmailValidation.apiKey = apiKey;
+});
+
+_defineProperty(AbstractEmailValidation, "verify", function (email) {
+  if (!email) {
+    throw new Error('Email is not provided.');
+  }
+
+  var self = AbstractEmailValidation;
+  return core.makeApiCall('emailvalidation', self.apiKey, "email=".concat(email)).then(function (response) {
+    // modify response so it returns Boolean instead of object
+    var modifiedResponse = response;
+    modifiedResponse['is_catchall_email'] = response.is_catchall_email.value;
+    modifiedResponse['is_disposable_email'] = response.is_disposable_email.value;
+    modifiedResponse['is_free_email'] = response.is_free_email.value;
+    modifiedResponse['is_mx_found'] = response.is_mx_found.value;
+    modifiedResponse['is_role_email'] = response.is_role_email.value;
+    modifiedResponse['is_smtp_valid'] = response.is_smtp_valid.value;
+    modifiedResponse['is_valid_format'] = response.is_valid_format.value;
+    return modifiedResponse;
+  })["catch"](function (error) {
+    return error;
+  });
+});