Node email address validation library
Lead Maintainer: Eli Skeggs
This library is a port of the PHP
is_email function by Dominic Sayers.
$ npm install isemail
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
npm install to get the development dependencies!
Determines whether the
options object and a
callback function. Options may include
callback function will always be called if specified, and the result of the operation supplied as the only parameter to the callback function. If
validate() is not asked to check for the existence of the domain (
checkDNS), it will also synchronously return the result of the operation.
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.
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 whitelist, the email will be marked as invalid.
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.
Only one of
tldWhitelist will be consulted for TLD validity.
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. To better handle fringe cases like the
io TLD, use the
checkDNS parameter, which will only allow email addresses for domains which have an MX record.
$ node> var Isemail = ;undefined> var log = consolelog;undefined> Isemail;true> Isemail;result truetrue> Isemail;undefined> Isemail;undefinedresult true> Isemail;0> Isemail;result 00> Isemail;true> Isemail;undefinedresult 6> Isemail;undefinedresult 0> Isemail;undefinedresult 6
: if this badge indicates the build is passing, then isemail has 100% code coverage.