email(modelValue: any): boolean

Returns true if the provided model value is a valid e-mail address according to RFC 5322.

Parameters:

Returns:

Boolean - Whether the provided model value is a valid.

Example:

import app from 'app';

import {
  email
} from '@darkobits/formation-validators';

function MyCtrl () {
  const vm = this;

  vm.controls = {
    emailAddress: {
      validators: {
        email
      },
      errors: [
        ['email', 'Please enter a valid e-mail address.']
      ]
    }
  };
}

app.component('myComponent', {
  controller: MyCtrl,
  controllerAs: 'vm',
  // ...
});