emailAddress validator

Validate an email address

Options

Using with form field
The HTML attributes are used to set the validator options via the Declarative plugin
NameHTML attributeTypeDescription
messagedata-fv-email-address___messageStringThe error message
multipledata-fv-email-address___multipleStringAllow multiple email addresses, separated by a comma or semicolon. The default value is false
separatordata-fv-email-address___separatorStringRegex for character or characters expected as separator between addresses. By default, it is /[,;]/, i.e. comma or semicolon
This validator passes an empty field since the field might be optional. If the field is required, then use the notEmpty validator
You also can use the remote validator to connect and validate the email address on the server. For example, the Mailgun plugin demonstrates how to do this.
Using with ES6 module
// You might need to change the importing path
import emailAddress from 'formvalidation/dist/es6/validators/emailAddress';
const result = emailAddress().validate({
value: ...,
options: {
message: ...,
multiple: ...,
separator: ...,
},
});
/*
result is an object of
{
valid: true or false,
message: The error message
}
*/

Basic example

Basic example

HTML5 Example

When the Declarative plugin is used, the emailAddress validator will be enabled automatically when using HTML5 type="email" attribute.
HTML5 example

ES6 Module Example

The following snippet shows how to use the emailAddress validator with ES6 module:
// You might need to change the importing path
import emailAddress from 'formvalidation/dist/es6/validators/emailAddress';
const res1 = emailAddress().validate({
value: 'niceandsimple@example.com',
options: {
message: 'The value is not a valid email address',
},
});
// res1.valid === true
const res2 = emailAddress().validate({
value: 'just"not"right@example.com',
options: {
message: 'The value is not a valid email address',
},
});
// res2.valid === false

See also

Changelog

v1.5.0
  • Fix a bug that emailAddress validator doesn't support multiple email addresses on IE 11