email-address-validation - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

package.json

 {
   "name": "email-address-validation",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Email Validation & Verification JSON API for Developers. Simple REST API measuring email deliverability & quality",
@@ -23,3 +23,15 @@ "main": "index.js",
   },
-  "homepage": "https://github.com/pmoelgaard/email-address-validation#readme"
+  "homepage": "https://github.com/pmoelgaard/email-address-validation#readme",
+  "devDependencies": {
+    "mocha": "^2.3.4",
+    "chai": "^3.4.1",
+    "dotenv": "^2.0.0"
+  },
+  "dependencies": {
+    "async": "^1.5.2",
+    "lodash": "^4.0.1",
+    "promise": "^7.1.1",
+    "request": "^2.69.0"
+  },
+  "tonicExampleFilename": "example/preview.js"
 }

README.md

@@ -1,3 +0,143 @@
-Email Validation & Verification JSON API for Developers. Simple REST API measuring email deliverability & quality
 
-# UNDER DEVELOPMENT
+[![Travis](https://travis-ci.org/pmoelgaard/email-address-validation.svg)](Travis)
+
+Node JavaScript wrapper for [the mailboxlayer API](https://mailboxlayer.com/).
+
+Supports both traditional callbacks and Promises/A+.
+
+---
+
+## Installation
+	npm install email-address-validation [--save]
+
+
+## Configuration
+
+Before using the mailboxlayer API client you have to setup your account and obtain your API Access Key.  
+You can get it by signing up at [https://mailboxlayerlayer.com/product](https://mailboxlayer.com/product).
+
+---
+
+## Usage
+
+The general API is documented here: [https://mailboxlayer.com/documentation](https://mailboxlayer.com/documentation).  
+You can find parameters, result set definitions and status codes documented here as well.
+
+
+### Setup
+
+	var API = require('email-address-validation');
+	var api = new API({
+    	access_key: [ACCESS_KEY],
+    	secure: [true|false] (Optional, defaults to false)
+	});
+
+#### Optional Parameters
+
+##### Secure (only available for Basic, Pro and Enterprise accounts)
+Boolean value to indicate if the calls to the API should use a secure protocol or insecure (HTTP/HTTPS). Defaults to false (HTTP, insecure).
+
+---
+
+## Callbacks vs. Promises
+
+The Promises/A+ implementation used for this is this excellent bare bones library:  
+[https://www.npmjs.com/package/promise](https://www.npmjs.com/package/promise)
+
+The language-detection library supports either mode and use of either one is not mutually exclusive to the alternative, so it's possible to use one exclusively or a combination, even in the same call, both the callback will be called and the promise handlers invoked.
+
+---
+
+## API Overview
+All endpoints in the public API is available through this library.
+
+- check
+
+---
+
+## Check
+Takes an email  and checks the email against the API.
+
+###### Define Query
+
+	var query = {
+    	email: '[e-mail]'
+	};
+
+###### Simple Request (using Callback)
+
+	api.check(query, function (err, result) {
+    	if (err) {
+        	return console.log('Check Callback (Error): ' + JSON.stringify(err));
+    	}
+	    console.log('Check Callback (Result): ' + result.length);
+	});
+    
+###### Response
+```
+{
+  "email": "[e-mail]",
+  "did_you_mean": "",
+  "user": "this.is.a",
+  "domain": "test.io",
+  "format_valid": true,
+  "mx_found": true,
+  "smtp_check": true,
+  "catch_all": false,
+  "role": true,
+  "disposable": false,
+  "free": false,
+  "score": 0.96
+}  
+```
+
+---
+
+## Example Application
+
+In the [rootdir]/example directory there is a fully functional application which runs all requests against all the endpoints in the API, the examples above can be seen there as source code.
+
+The example application uses a process.env variable to hold the access key.
+
+For running in development environments, it's easy to use the [https://www.npmjs.com/package/dotenv](https://www.npmjs.com/package/dotenv) to load variables from a local file into the environment.
+
+---
+
+## Tests
+
+The tests are written for any NodeJS testing library, but has been run and targeted at the [https://mochajs.org/](https://mochajs.org/) testing library.
+
+---
+
+## Customer Support
+
+Need any assistance? [Get in touch with Customer Support](mailto:[e-mail]?subject=%mailboxlayer%5D).
+
+---
+
+## Updates
+Stay up to date by following [@apilayernet](https://twitter.com/apilayernet) on Twitter.
+
+---
+
+## Legal
+
+All usage of the mailboxlayer website, API, and services is subject to the [mailboxlayer Terms & Conditions](https://mailboxlayer.com/terms) and all annexed legal documents and agreements.
+
+---
+
+## Author
+Peter Andreas Moelgaard ([GitHub](https://github.com/pmoelgaard), [Twitter](https://twitter.com/petermoelgaard))
+
+---
+
+## License
+Licensed under the The MIT License (MIT)
+
+Copyright (©) 2016 Peter Andreas Moelgaard & apilayer
+
+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.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18054

increased by14.13%

Number of package files

17

increased by54.55%

Lines of code

358

increased byInfinity%

Number of lines in readme file

143

increased by4666.67%

Worsened metrics

Dependency count

4

increased byInfinity%

Dev dependency count

3

increased byInfinity%

Number of low supply chain risk alerts

4

increased byInfinity%

Dependency changes

• + Addedasync@^1.5.2

• + Addedlodash@^4.0.1

• + Addedpromise@^7.1.1

• + Addedrequest@^2.69.0

• + Addedajv@6.12.6(transitive)

• + Addedasap@2.0.6(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasync@1.5.2(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.2(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedcore-util-is@1.0.2(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.3.3(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedlodash@4.17.21(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedoauth-sign@0.9.0(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedpromise@7.3.1(transitive)

• + Addedpsl@1.15.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@6.5.3(transitive)

• + Addedrequest@2.88.2(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)