neverbounce

Looking for the V3 API wrapper? Click here.

This is the official NeverBounce API NodeJS wrapper. It provides helpful methods to quickly implement our API in your NodeJS applications.

This package is not suitable for use in the browser! Only use it in server side applications!

Installation

To install use the following command

$ npm install neverbounce --save

Basic Usage

const NeverBounce = require('../src/NeverBounce.js');

// Initialize NeverBounce client
const client = new NeverBounce('secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');

// Verify an email
client.single.check('[e-mail]').then(
    result => {
        console.log('Result: ' + result.getResult());
    },
    err => console.log('ERROR: ' + err.message)
);

The API username and secret key used to authenticate V3 API requests will not work to authenticate V4 API requests. If you are attempting to authenticate your request with the 8 character username or 12-16 character secret key the request will return an auth_failure error. The API key used for the V4 API will look like the following: secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx. To create new V4 API credentials please go here.

For more information you can check out the /examples directory contained within the repository or visit our official documentation here.

Running Examples

There a several examples contained within the /examples directory included in this repo. To run these examples; first create a .env.js file in the project root containing the following text (substituting in your own API key):

module.exports = {
  apiKey: 'secret_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
};

Once that file has been created you can run the examples with the following command, replacing the script name with the specific example you intend to run.

node ./examples/account-info.js