電子郵件

編輯此頁面

驗證值是否為有效的電子郵件地址。底層值在驗證前會先轉換為字串。

適用於	屬性或方法
類別	電子郵件
驗證器	電子郵件驗證器

基本用法

        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="https://symfony.dev.org.tw/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://symfony.dev.org.tw/schema/dic/constraint-mapping https://symfony.dev.org.tw/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.',
        ]));
    }
}
    

注意

與大多數其他約束條件一樣，null 和空字串被視為有效值。這是為了允許它們成為可選值。如果該值是強制性的，一個常見的解決方案是將此約束條件與 NotBlank 結合使用。

選項

`群組`

類型：array | string 預設：null

它定義了此約束條件的驗證群組。閱讀更多關於驗證群組的資訊。

`訊息`

類型：string 預設：此值不是有效的電子郵件地址。

如果底層資料不是有效的電子郵件地址，則會顯示此訊息。

您可以在此訊息中使用以下參數

參數	描述
`{{ value }}`	目前的（無效）值
`{{ label }}`	對應的表單欄位標籤

`模式`

類型：string 預設：html5

此選項定義用於驗證電子郵件地址的模式。有效值為

html5 使用 HTML5 電子郵件輸入元素的正規表示式，但強制要求必須存在 TLD。
html5-allow-no-tld 完全使用與 HTML5 電子郵件輸入元素相同的正規表示式，使後端驗證與瀏覽器提供的驗證一致。
strict 根據 RFC 5322，使用 egulias/email-validator 程式庫驗證地址（當使用 Symfony Mailer 時已安裝；否則，您必須單獨安裝）。

提示

此選項的可能值也定義為 Email 的 PHP 常數（例如 Email::VALIDATION_MODE_STRICT）。

此選項使用的預設值在 framework.validation.email_validation_mode 設定選項中設定。

`正規化器`

類型：PHP 可呼叫預設：null

此選項允許定義在檢查給定值是否有效之前，應用於該值的 PHP 可呼叫物件。

例如，您可能想要傳遞 'trim' 字串以應用 trim PHP 函數，以便在驗證期間忽略開頭和結尾的空白字元。

`酬載`

類型：mixed 預設：null

此選項可用於將任意特定領域的資料附加到約束條件。Validator 元件不使用已設定的酬載，但其處理完全由您決定。

例如，您可能想要使用多個錯誤等級，以便根據錯誤的嚴重性在前端以不同方式呈現失敗的約束條件。

這項工作，包括程式碼範例，根據 Creative Commons BY-SA 3.0 授權條款獲得許可。

版本