Email

Дата обновления перевода 204-07-25

Email

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

??????????? ?	???????? ??? ??????
?????	Email
?????????	EmailValidator

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

        1
2
3
4
5
6
7
8
9
10
11
12
        // 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 string $email;
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\Author:
    properties:
        email:
            - Email:
                message: The email "{{ value }}" is not a valid email.
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- config/validator/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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\Author">
        <property name="email">
            <constraint name="Email">
                <option name="message">The email "{{ value }}" is not a valid email.</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        // src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class Author
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('email', new Assert\Email([
            'message' => 'The email "{{ value }}" is not a valid 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.

Опции

`groups`

type: array | string default: null

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

`message`

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

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

Вы можете использовать следующие параметры в этом сообщении:

????????	????????
`{{ value }}`	??????? (??????????) ????????
`{{ label }}`	??????????????? ????? ???? ?????

`mode`

тип: string по умолчанию: loose

Эта опция необязательна и определяет схему, по которой валидируется адрес электронной почты. Валидными значениями являются:

loose использует простое регулярное выражение (просто проверяет, чтобы присутствовал хотя бы один символ @ и т.д.). Эта валидация слишком простая и рекомендуется использовать один из других режимов;
html5 использует регулярное выражение элемент ввода электронной почты HTML5, только форсирует наличие tld.
html5-allow-no-tld использует точно такое же регулярное выражение, как и элемент ввода электронной почты HTML5, что делает валидацию бэк-энда соответствующей той, что предоставлена браузерами.
strict валидирует адреса в соответствии с RFC 5322, используя библиотеку egulias/email-validator (которая уже установлена при использовании Symfony Mailer; в других случаях, вам нужно установить её отдельно).

Tip

Возможные значения этой опции также определены как PHP-константы Email (например, Email::VALIDATION_MODE_STRICT).

Значение, по умолчанию использованное этой опцией, установлено в опции конфигурации framework.validation.email_validation_mode .

`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.

Дата обновления перевода 2024-07-25

payload

тип: mixed по умолчанию: null

Эта опция может быть использована, чтобы добавить к ограничению произвольные данные, относящиеся к домену. Сконфигурированная нагрузка не используется компонентом Валидатор, но его обработка полностью зависит от вас.

Например, вы можете захотеть исользовать несколько уровней ошибок, чтобы представить неудачные ограничения в фронт-энде по-разному, в зависимости от степени сложности ошибки.