isemail

by skeggse

skeggse / isemail

validate an email address according to RFCs 5321, 5322, and others

221 Stars 42 Forks Last release: about 2 years ago (v3.2.0) Other 117 Commits 16 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

isemail

Node email address validation library

Build Status[1]

Lead Maintainer: Eli Skeggs

This library is a port of the PHP

is_email
function by Dominic Sayers.

Install

$ npm install isemail

Test

The tests were pulled from

is_email
's extensive test suite on October 15, 2013. Many thanks to the contributors! Additional tests have been added to increase code coverage and verify edge-cases.

Run any of the following.

$ lab
$ npm test
$ make test

remember to

npm install
to get the development dependencies!

API

validate(email, [options])

Determines whether the

email
is valid or not, for various definitions thereof. Optionally accepts an
options
object. Options may include
errorLevel
.

Use

errorLevel
to specify the type of result for
validate()
. Passing a
false
literal will result in a true or false boolean indicating whether the email address is sufficiently defined for use in sending an email. Passing a
true
literal will result in a more granular numeric status, with zero being a perfectly valid email address. Passing a number will return
0
if the numeric status is below the
errorLevel
and the numeric status otherwise.

The

tldBlacklist
option can be either an object lookup table or an array of invalid top-level domains. If the email address has a top-level domain that is in the blacklist, the email will be marked as invalid.

The

tldWhitelist
option can be either an object lookup table or an array of valid top-level domains. If the email address has a top-level domain that is not in the whitelist, the email will be marked as invalid.

The

allowUnicode
option governs whether non-ASCII characters are allowed. Defaults to
true
per RFC 6530.

Only one of

tldBlacklist
and
tldWhitelist
will be consulted for TLD validity.

The

minDomainAtoms
option is an optional positive integer that specifies the minimum number of domain atoms that must be included for the email address to be considered valid. Be careful with the option, as some top-level domains, like
io
, directly support email addresses.

As of

3.1.1
, the
callback
parameter is deprecated, and will be removed in
4.0.0
.

Examples

$ node
> var Isemail = require('isemail');
undefined
> Isemail.validate('[email protected]');
true
> Isemail.validate('[email protected]');
true
> Isemail.validate('[email protected]', {errorLevel: true});
0
> Isemail.validate('[email protected]', {errorLevel: true});
10
> Isemail.validate('[email protected]', {errorLevel: 17});
0
> Isemail.validate('[email protected]', {errorLevel: 10});
10
> Isemail.validate('[email protected]&12');
false
> Isemail.validate('[email protected]&12', {errorLevel: true});
65
> Isemail.validate('[email protected]', {errorLevel: true});
131

[1]: if this badge indicates the build is passing, then isemail has 100% code coverage.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.