Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 2.69 KB

Readme.md

File metadata and controls

102 lines (74 loc) · 2.69 KB
Raw

ssmith-is-valid-email

A Robust Tool for Validating Emails

Codeship Status for ssmith-wombatweb/is-valid-email Code Coverage Dependencies npm version

Project Repo

This script checks the validity of a wide range of email types. It follows most of the rules outlined here: Email Address - Wikipedia. It was created because of performance issues with RegEx when working with emails in React.

Author

Written by Simeon Smith.

Portfolio | Resume | Github

Installation

npm i -S ssmith-is-valid-email

Using the Function

This function supports all modern browser including IE9+.

Importing

ES6 JS

import isValidEmail from 'ssmith-is-valid-email';

Common JS Import

const isValidEmail = require('ssmith-is-valid-email');

Calling the Function

isValidEmail('[email protected]');
// Returns true or false.

Testing

The following emails were tested. It follows most of the rules outlined here: Email Address - Wikipedia.

Valid Emails

[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
" "@example.org

Invalid Emails

Abc.example.com
@Abc.example.com
james@google
[email protected]
james [email protected]
james" [email protected]
james@cb$.com
A@b@[email protected]
a"b(c)d,e:f;g<h>i[j\\k][email protected]
just"not"[email protected]
just."not"[email protected]
1234567890123456789012345678901234567890123456789012345678901234+x@example.com
[email protected]
[email protected]

Not Yet Supported

Should Be Valid

"very.(),:;<>[]\".VERY.\"very@\\ \"very\".unusual"@strange.example.com

Not Useful to Support

admin@mailserver1

Performance

This script will run 1000 times on a valid or invalid email in less than 20 milliseconds.