Email

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

Applies to	property or method
Options	message checkMX
Class	Symfony\Component\Validator\Constraints\Email
Validator	Symfony\Component\Validator\Constraints\EmailValidator

Basic Usage

• YAML

  # src/BlogBundle/Resources/config/validation.yml
  Acme\BlogBundle\Entity\Author:
      properties:
          email:
              - Email:
                  message: The email "{{ value }}" is not a valid email.
                  checkMX: true
  

• Annotations

  // src/Acme/BlogBundle/Entity/Author.php
  namespace Acme\BlogBundle\Entity;
  
  use Symfony\Component\Validator\Constraints as Assert;
  
  class Author
  {
      /**
       * @Assert\Email(
       *     message = "The email '{{ value }}' is not a valid email.",
       *     checkMX = true
       * )
       */
       protected $email;
  }
  

Options

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.

checkMX

type: Boolean default: false

If true, then the checkdnsrr PHP function will be used to check the validity of the MX record of the host of the given email.