Validates that a value is a valid email address. The underlying value is cast to a string before being validated.
.. configuration-block::
.. code-block:: 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
.. code-block:: php-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;
}
.. code-block:: xml
<!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
<class name="Acme\BlogBundle\Entity\Author">
<property name="email">
<constraint name="Email">
<option name="message">The email "{{ value }}" is not a valid email.</option>
<option name="checkMX">true</option>
</constraint>
</property>
</class>
</constraint-mapping>
.. code-block:: php
// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('email', new Assert\Email(array(
'message' => 'The email "{{ value }}" is not a valid email.',
'checkMX' => true,
)));
}
}
.. versionadded:: 2.5
The ``strict`` option was introduced in Symfony 2.5.
type: boolean default: false
When false, the email will be validated against a simple regular expression. If true, then the egulias/email-validator library is required to perform an RFC compliant validation.
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.
type: Boolean default: false
If true, then the :phpfunction:`checkdnsrr` PHP function will be used to check the validity of the MX record of the host of the given email.
type: Boolean default: false
If true, then the :phpfunction:`checkdnsrr` PHP function will be used to check the validity of the MX or the A or the AAAA record of the host of the given email.