Email

Валидирует, что значение является валидным адресом электронной почты. Основоположное значение преобразовывается в строку перед валидацией.

Применяется к свойству или методу
Опции
Класс Email
Валидатор EmailValidator

Базовое применение

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    // src/AppBundle/Entity/Author.php
    namespace AppBundle\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Author
    {
        /**
         * @Assert\Email(
         *     message = "Электронный адрес '{{ value }}' не является валидным.",
         *     checkMX = true
         * )
         */
         protected $email;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    7
    # src/AppBundle/Resources/config/validation.yml
    AppBundle\Entity\Author:
        properties:
            email:
                - Email:
                    message: Электронный адрес '{{ value }}' не является валидным.
                    checkMX: true
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    <!-- src/AppBundle/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="AppBundle\Entity\Author">
            <property name="email">
                <constraint name="Email">
                    <option name="message">Электронный адрес '{{ value }}' не является валидным.</option>
                    <option name="checkMX">true</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    // src/AppBundle/Entity/Author.php
    namespace AppBundle\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' => 'Электронный адрес '{{ value }}' не является валидным.',
                'checkMX' => true,
            )));
        }
    }
    

Опции

strict

тип: boolean по умолчанию: false

Если установлена, как "false", то электронный адрес будет валидирован с простым регулярным выражением. Если "true", то необходима библиотека egulias/email-validator, чтобы провести RFC-применимую валидацию.

message

тип: string по умолчанию: Это значение не является валидным электронным адресом.

Это сообщение отображается, если осоновоположные данные не являются валидным адресом электронной почты.

checkMX

тип: boolean по умолчанию: false

Если "true", то PHP-функция checkdnsrr будет использована для проверки валидности MX записи хоста данного электронного адреса.

checkHost

тип: boolean по умолчанию: false

Если "true", то PHP-функция checkdnsrr будет использована для проверки валидности MX или А или ААА записи хоста данного электронного адреса.

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.

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.