isEmail

Test if a value is an email address.

Installation

npm install @stdlib/assert-is-email-address

Usage

var isEmail = require( '@stdlib/assert-is-email-address' );

isEmail( value )

Tests if a value is an email address.

var bool = isEmail( '[email protected]' );
// returns true

Notes

• Validation is not rigorous, nor should it be. 9 RFCs relate to email addresses, and accounting for all of them is a fool's errand. This module performs the simplest validation; i.e., requiring at least one @ symbol.
• For rigorous validation, send a confirmation email. If the email bounces, consider the email invalid.

Examples

var isEmail = require( '@stdlib/assert-is-email-address' );

var bool;

bool = isEmail( '[email protected]' );
// returns true

bool = isEmail( 'beep' );
// returns false

bool = isEmail( 'beep.com' );
// returns false

bool = isEmail( null );
// returns false

See Also

• @stdlib/assert-is-email-address-cli: CLI package for use as a command-line utility.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.