Email

Version: 6.0
Edit this page

Email

Validates that a value is a valid email address. The underlying value is cast to a string before being validated.

Basic Usage

  • Annotations
  • Attributes
  • YAML
  • XML
  • PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\Email(
     *     message = "The email '{{ value }}' is not a valid email."
     * )
     */
    protected $email;
}

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Options

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

message

type: string default: This value is not a valid email address.

This message is shown if the underlying data is not a valid email address.

You can use the following parameters in this message:

Parameter Description
{{ value }} The current (invalid) value
{{ label }} Corresponding form field label

mode

type: string default: (see below)

This option defines the pattern used to validate the email address. Valid values are:

  • loose uses a simple regular expression (just checks that at least one @ character is present, etc.). This validation is too simple and it's recommended to use one of the other modes instead;
  • html5 uses the same regular expression as the HTML5 email input element, making the backend validation consistent with the one provided by browsers;
  • strict uses the egulias/email-validator library (which you must install separately) for validation according to RFC 5322.

The default value used by this option is set in the framework.validation.email_validation_mode configuration option.

normalizer

type: a PHP callable default: null

This option allows to define the PHP callable applied to the given value before checking if it is valid.

For example, you may want to pass the 'trim' string to apply the trim PHP function in order to ignore leading and trailing whitespace during validation.

payload

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.