checkmail v1.0.0

Sign up for a CheckMail account and visit our developer site for even more details.

Node.js Client Library

The official Node.js binding for your CheckMail service.

Prerequisites

Before using this library, you must have:

• A CheckMail Account, sign up for a new account or login to CheckMail
• a valid CheckMail account SID and auth token, available from the CheckMail Portal

Installation

npm install checkmail

Quickstart

Verify an email address

var client = require('checkmail')('your_account_sid', 'your_auth_token');

client.verify.get('test@example.com').then(data => {

    console.log(data);

}).catch(err => {

    console.log(err);
});

That will output a JSON object that looks like this:

{
    accept_all: false,
    corrected: false,
    country_code: '',
    country_name: '',
    disposable: false,
    domain: 'example.com',
    email_request: 'test@example.com',
    email_result: 'test@example.com',
    free: false,
    localpart: 'test',
    reason: 'smtp_missing',
    result: 'risky',
    role: true,
    social_media: false
}

Documentation

Full API documentation is available from the CheckMail developer site.

Release History

• 1.0.0 - Initial release