a small, dependency-free email validator with configurable rules and suggested corrections

Install

npm install scniro-validator --save

Sample usage

var v = require('scniro-validator');

var result = v.validate('[email protected]');
// {valid: true}

Configuration

validation may be influenced by calling optional .init with a configuration object

var rules = {
    tld: {
        allowed: ['com']
    sdl: {
        allowed: ['bar']
    }
}

var result = v.validate('[email protected]');
// {valid: false}

Corrections

validation will include a suggested correction base on corrections defined via tld and sld supplied match objects (top-level domain and second-level domain, respectively). Specify this via tryCorrect.

var rules = {
    tld: {
        allowed: ['com'],
        corrections: [
            {match: 'con.au', correct: 'com'}
        ]
    }
}

var result = v.validate('[email protected]', {tryCorrect: true});
// {valid: false, correction: '[email protected]'}

or a really barged example

var rules = {
    tld: {
        allowed: ['com'],
        corrections: [
            {match: 'con.au', correct: 'com'}
        ]
    },
    sdl: {
        allowed: ['bar']
    }
}

var result = v.validate('foo.bar.con.au', {tryCorrect: true});
// {valid: false, correction: '[email protected]'}

Note

e-mail validation is a rabbit whole, and this tool does not aim to be a silver bullet. The capability of this tool is influenced from the w3c type="email" validation, ships with some extensibility specific to a business defined problem, and is pessimistic in nature. For a less problem-specific validation tool, check out the awesome mailcheck.js