Official QuickEmailVerification API library client for node.js. 

Official QuickEmailVerification API library client for node.js

quickemailverification

Error

Ignore

Warn

License

Maintenance

Miscellaneous

Quality

Supply chain risk

Vulnerability

Admins only

Organization members

Dashboard

<upgradeLink>Upgrade</upgradeLink> to access this feature

About

Blog

Socket CLI

Customers

Socket Dependency Search

Docs

Socket for GitHub

Love

Impersonation Mode Active

Update your browser to the latest version for the best experience.

Your web browser is outdated

Use another browser for the best experience.

Your web browser is unsupported

{{count, number}} commits last two months

{{count, number}} critical severity alert

{{count, number}} critical severity alerts

{{count, number}} dependency vulnerability

{{count, number}} dependency vulnerabilities

{{count, number}} development dependencies

{{count, number}} transitive dependencies

{{count, number}} version published last month

{{count, number}} versions published last month

{{count, number}} version published in last two months

{{count, number}} versions published in last two months

{{count, number}} version published last week

{{count, number}} versions published last week

{{count, number}} version published last year

{{count, number}} versions published last year

Socket undergoes annual SOC2 Type II audits. Socket customers can request a copy of the full SOC2 Type II report.

Allows organization owners and admins to access detailed records of actions taken by members of their organization, complete with timestamps.

Prevent compromised packages from infiltrating your supply chain by monitoring for changes in real-time.

Join our Discord community to get help from Socket engineers and other Socket users.

Compare millions of open source packages on socket.dev

Detect malicious code and risky behavior (e.g. network) in your dependencies using "deep package inspection"

All data is encrypted in transit and at rest using industry standard encryption algorithms.

Get a dedicated Socket account manager and access to Socket’s Customer Success team.

Get dedicated support from Socket engineers via email and Slack.

"Shift left" with the Socket Chrome extension and give intervene early, before developers choose risky or low quality dependencies.

Catch developers using risky dependencies and give them a "speed bump" to encourage good behavior

Install the Socket GitHub app to receive real-time dependency scanning and reports with every pull request.

Integrate Socket into your GitHub SCM to prevent risky dependencies from being installed.

Socket scans for vulnerabilities in your dependencies, including CVEs, security advisories, and more.

Socket supports dependencies in many languages, with most popular ecosystems coming in 2024. We've got you covered no matter what languages you use.

Enforce license policies across your organization

Receive a Microsoft Teams message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Get help migrating from Socket's free plan to Socket's paid plans.

Run Socket on-premises or in your own cloud environment.

Query for any dependency (at any version) across your entire organization

Integrate Socket into your CI/CD pipeline to prevent risky dependencies from being deployed to production.

Analyze an entire project to find supply chain risks

Tag projects to organize and filter your projects

Restrict access based on the roles of individual users within an organization.

Receive a Slack message to the channel of your choice anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket is SOC2 Type II compliant and undergoes annual audits.

The Socket CLI allows teams to prevent risky dependencies from being installed, and to get dependency insights from the command line.

Socket supports SAML SSO for single sign-on and identity management.

Integrate Socket into your VS Code IDE to prevent risky dependencies from being installed.

Get a POST request anytime Socket runs a new analysis, has a new finding, or a policy has changed.

Socket will analyzed your SBOMs up to a maximum number of dependencies.

API that allows you to analyze a project, lookup package scores and alerts, and more.

Create API tokens to authenticate with the Socket API and CLI.

The number of developers in your team. A developer is someone who made a commit to your organization's repositories scanned by Socket in the past month.

Use Socket to protect your private repositories.

Socket is always free for open source projects.

Socket retains all reporting data for 3 months, 1 year, or a custom term of your choice.

Access the threat feed that powers Socket.

Unlimited scale, self-hosting, and priority support for large teams.

For open-source projects, individuals, and small teams.

For growing teams with enhanced scale, security, and support.

There is a package with a similar name that is downloaded much more often.

There are packages with similar names that are downloaded much more often.

This may not be the package you want!

Instance

Alert Locations

Package

The {{ecosystem}} package {{- packageName}} receives a total of <strong>{{numWeeklyDownloadCount, number}}</strong> weekly downloads. As such, {{- packageName}} popularity was classified as <strong>{{popularity}}</strong>.

Is {{- packageName}} popular?

Is {{- packageName}} safe to use?

Is {{- packageName}} well maintained?

What is {{- packageName}}?

{{packageDescription}}Version: {{versionString}} was published by {{publisherName}}. Start using Socket to analyze {{- packageName}} and its {{dependencyCount, number}} dependencies to secure your app from supply chain attacks.

Sorry, it seems this package was removed from the registry

Package was removed

This package version has been unpublished, mostly likely due to security reasons

Package version was removed

Provide a detailed description of the malware...

Socket fights vulnerabilities and provides visibility, defense-in-depth, and proactive supply chain protection for JavaScript, Python, and Go dependencies.

Socket - Secure your dependencies. Ship with confidence.

Compare versions

{{- packageName}} - npm Package Compare versions

client.AuthHandler = require('./auth_handler');

client.ErrorHandler = require('./error_handler');

client.RequestHandler = require('./request_handler');

client.ResponseHandler = require('./response_handler');

client.Response = require('./response.js');

 * Main HttpClient which is used by Api classes

client.HttpClient = function (auth, options) {

    'base': 'http://api.quickemailverification.com',

    'user_agent': 'quickemailverification-node/v1.0.2 (https://github.com/quickemailverification/quickemailverification-node)'

    'user_agent': 'quickemailverification-node/v1.0.3 (https://github.com/quickemailverification/quickemailverification-node)'

    'user-agent': this.options['user_agent']

    for (var key in this.options['headers']) {

      this.headers[key.toLowerCase()] = this.options['headers'][key];

  this.auth = new client.AuthHandler(auth);

client.HttpClient.prototype.get = function (path, params, options, callback) {

  this.request(path, {}, 'GET', options, callback);

client.HttpClient.prototype.post = function (path, body, options, callback) {

  this.request(path, body, 'POST', options, callback);

client.HttpClient.prototype.patch = function (path, body, options, callback) {

  this.request(path, body, 'PATCH', options, callback);

client.HttpClient.prototype.delete = function (path, body, options, callback) {

  this.request(path, body, 'DELETE', options, callback);

client.HttpClient.prototype.put = function (path, body, options, callback) {

  this.request(path, body, 'PUT', options, callback);

 * Intermediate function which does three main things

 * - Transforms the body of request into correct format

 * - Creates the requests with give parameters

 * - Returns response body after parsing it into correct format

client.HttpClient.prototype.request = function (path, body, method, options, callback) {

    reqobj = this.setBody(reqobj, body, options);

  this.auth.set(reqobj, function (err, reqobj) {

  "description": "Official QuickEmailVerification API library client for node.js",

  "author": "quickemailverification <support@quickemailverification.com> (https://quickemailverification.com)",

  "homepage": "https://quickemailverification.com",

    "url": "https://github.com/quickemailverification/quickemailverification-node"

    "url": "https://github.com/quickemailverification/quickemailverification-node/issues"

# Official Email Validation API library client for Node.js

[![Build Status](https://travis-ci.org/quickemailverification/quickemailverification-node.svg?branch=master)](https://travis-ci.org/quickemailverification/quickemailverification-node)

[![npmjs Version](https://img.shields.io/npm/v/quickemailverification.svg)](https://www.npmjs.com/package/quickemailverification)

[![Total Downloads](https://img.shields.io/npm/dt/quickemailverification.svg)](https://www.npmjs.com/package/quickemailverification)

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.

To begin, signUp at [quickemailverification.com](https://quickemailverification.com) and create a FREE account. After signup logged in, click on **[API Settings](https://quickemailverification.com/apisettings)** 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.

Make sure you have [npm](https://npmjs.org) installed.

var quickemailverification = require('quickemailverification').client('Your_API_Key_Here').quickemailverification();

quickemailverification.verify("test@example.com", function (err, response) {

//quickemailverification.sandbox("valid@example.com", function (err, response) {

A successful API call responds with the following values:

- **result** `string` - The verified results will be: `valid`, `invalid`, `unknown`

- **reason** `string` - Reason definitions are as below:

  - `invalid_email` - Specified email has invalid email address syntax

  - `invalid_domain` - Domain name does not exist

  - `rejected_email` - SMTP server rejected email. Email does not exist

  - `accepted_email` - SMTP server accepted email address

  - `no_connect` - SMTP server connection failure

  - `timeout` -  Session time out occurred at SMTP server

  - `unavailable_smtp` - SMTP server is not available to process request

  - `unexpected_error` - An unexpected error has occurred

  - `no_mx_record` - Could not get MX records for domain

  - `temporarily_blocked` - Email is temporarily greylisted 

  - `exceeded_storage` - SMTP server rejected email. Exceeded storage allocation

- **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

- **role**  `true | false` - *true* if the email address is a *role* address (`manager@example.com`, `ceo@example.com`, etc)

- **free** `true | false` - *true* if the email address is from free email provider like Gmail, Yahoo!, Hotmail 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`)

- **mx_record** `string` - The preferred MX record of email domain. This field contains empty string when MX record is not available.

- **mx_domain** `string` - The domain name of the MX host. This field contains empty string when MX record is not available.

- **safe_to_send** `true | false` - *true* if the email address is safe for deliverability

- **did_you_mean** `string` - Returns email suggestions if specific typo errors found in email

- **success** `true | false` - *true* if the API request was successful

- **message** `string` - Describes API call failure reason

Total remaining credits can be found by http response header. It contains overall remaining credits, including Persistent & Per day credits.

- **X-QEV-Remaining-Credits** - Your remaining email verification credits (i.e. Per Day credits + Persistent Credits).

## 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 successfully

- `400` - 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.

- `429` - Too many requests. Rate limit exceeded.

QuickEmailVerification single email verification API sandbox mode helps developers to test their integration against simulated results. Requesting against sandbox endpoint is totally free and no credits will be deducted from actual credit quota.

Please refer our [knowledge base](http://docs.quickemailverification.com/email-verification-api/sandbox-mode) to learn more about sandbox mode.

		@@ -34,3 +34,3 @@ var url = require('url')
		'api_version': 'v1',
		'user_agent': 'quickemailverification-node/v1.0.2 (https://github.com/quickemailverification/quickemailverification-node)'
		'user_agent': 'quickemailverification-node/v1.0.3 (https://github.com/quickemailverification/quickemailverification-node)'
		};
		@@ -37,0 +37,0 @@

		{
		"name": "quickemailverification",
		"version": "1.0.2",
		"version": "1.0.3",
		"description": "Official QuickEmailVerification API library client for node.js",
		@@ -24,2 +24,5 @@ "author": "quickemailverification <support@quickemailverification.com> (https://quickemailverification.com)",
		},
		"scripts": {
		"test": "mocha"
		},
		"main": "./lib/index.js",
		@@ -33,2 +36,6 @@ "dependencies": {
		"license": "MIT",
		"devDependencies": {
		"chai": "^4.2.0",
		"mocha": "^5.2.0"
		},
		"engines": {
		@@ -35,0 +42,0 @@ "node": ">= 0.8.0"

New alerts

Fixed alerts

Improved metrics

Worsened metrics

		<p align="center">
		<img src="https://quickemailverification.com/extra/images/logo_github.png" alt="Quick Email Verification">
		<img src="https://quickemailverification.com/images/logo_github.png" alt="Quick Email Verification">
		<br>
		@@ -8,2 +8,6 @@ </p>

		[![Build Status](https://travis-ci.org/quickemailverification/quickemailverification-node.svg?branch=master)](https://travis-ci.org/quickemailverification/quickemailverification-node)
		[![npmjs Version](https://img.shields.io/npm/v/quickemailverification.svg)](https://www.npmjs.com/package/quickemailverification)
		[![Total Downloads](https://img.shields.io/npm/dt/quickemailverification.svg)](https://www.npmjs.com/package/quickemailverification)

		QuickEmailVerification provides the quickest way to avoid fake / invalid emails.
		@@ -10,0 +14,0 @@