`

This is the official TrueMail 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 truemail-io --save

Basic Usage

All requests to TrueMail Api required api key. To create new API credentials please go here.

const trueMail = require('truemail-io')({apiKey: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'});

// Verify an email
trueMail.single.check('[email protected]', false).then(
    res => {
        console.log(res);

        //  { result: 'valid',
        //   status: 'success',
        //   email_id: 10441490,
        //   fqdn: 'google.com',
        //   suggested_correction: '',
        //   verification_time: 1456 }
    },
    err => {
        console.log(err);
    }
);

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

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: '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/single-verify.js

`