EmailValidator.message を使ったサンプルコード

Django の EmailValidator.message について

Django の django.core.validators.EmailValidator.message は、フォームやモデルで使用される EmailValidator クラスの属性です。この属性は、メールアドレスのバリデーションに失敗した場合に表示されるエラーメッセージを指定します。

デフォルトでは、EmailValidator.message は以下の値に設定されています。

message = _("Enter a valid email address.")

これは、英語で "有効なメールアドレスを入力してください" という意味です。

使い方

EmailValidator.message は、文字列または翻訳オブジェクトを設定できます。

例：メッセージを日本語に変更する

from django.core.validators import EmailValidator

email_validator = EmailValidator(
    message=_("有効なメールアドレスを入力してください。"),
)

例：メッセージを動的に生成する

from django.utils.translation import gettext_lazy

def get_email_validator_message(user):
    return gettext_lazy(
        "{} さんのメールアドレスを入力してください。",
        username=user.username,
    )

email_validator = EmailValidator(
    message=get_email_validator_message,
)

補足

• EmailValidator.message は、バリデーションエラーが発生した場合にのみ表示されます。
• EmailValidator は、RFC 5322 に準拠したメールアドレスを検証します。
• EmailValidator は、最大320文字までのメールアドレスを検証します。
• EmailValidator は、ドメイン名のブラックリストを設定することもできます。

EmailValidator.message を使ったサンプルコード

from django.core.validators import EmailValidator

email_validator = EmailValidator(
    message=_("有効なメールアドレスを入力してください。"),
)

# フォーム
class MyForm(forms.Form):
    email = forms.EmailField(validators=[email_validator])

# モデル
class MyModel(models.Model):
    email = models.EmailField(validators=[email_validator])

メッセージを動的に生成する

from django.utils.translation import gettext_lazy

def get_email_validator_message(user):
    return gettext_lazy(
        "{} さんのメールアドレスを入力してください。",
        username=user.username,
    )

email_validator = EmailValidator(
    message=get_email_validator_message,
)

# フォーム
class MyForm(forms.Form):
    email = forms.EmailField(validators=[email_validator])

# モデル
class MyModel(models.Model):
    email = models.EmailField(validators=[email_validator])

ドメイン名のブラックリストを設定する

from django.core.validators import EmailValidator

email_validator = EmailValidator(
    message=_("有効なメールアドレスを入力してください。"),
    domain_blacklist=["example.com", "example.org"],
)

# フォーム
class MyForm(forms.Form):
    email = forms.EmailField(validators=[email_validator])

# モデル
class MyModel(models.Model):
    email = models.EmailField(validators=[email_validator])

複数のバリデーションエラーメッセージを設定する

from django.core.validators import EmailValidator, ValidationError

def validate_email(value):
    if not value:
        raise ValidationError(_("メールアドレスを入力してください。"))

    email_validator = EmailValidator(
        message=_("有効なメールアドレスを入力してください。"),
    )

    try:
        email_validator(value)
    except ValidationError as e:
        raise ValidationError(e.messages)

# フォーム
class MyForm(forms.Form):
    email = forms.CharField(validators=[validate_email])

# モデル
class MyModel(models.Model):
    email = models.CharField(validators=[validate_email])

カスタムバリデーションロジックを実装する

from django.core.validators import EmailValidator, ValidationError

def validate_email(value):
    if not value:
        raise ValidationError(_("メールアドレスを入力してください。"))

    if value.endswith("@example.com"):
        raise ValidationError(_("example.com ドメインは使用できません。"))

    email_validator = EmailValidator(
        message=_("有効なメールアドレスを入力してください。"),
    )

    try:
        email_validator(value)
    except ValidationError as e:
        raise ValidationError(e.messages)

# フォーム
class MyForm(forms.Form):
    email = forms.CharField(validators=[validate_email])

# モデル
class MyModel(models.Model):
    email = models.CharField(validators=[validate_email])

EmailValidator.message 以外の方法

フォームの clean_ メソッドを使う

class MyForm(forms.Form):
    email = forms.EmailField()

    def clean_email(self):
        value = self.cleaned_data["email"]

        if not value:
            raise ValidationError(_("メールアドレスを入力してください。"))

        if value.endswith("@example.com"):
            raise ValidationError(_("example.com ドメインは使用できません。"))

        return value

モデルの validate_ メソッドを使う

class MyModel(models.Model):
    email = models.EmailField()

    def validate_email(self):
        if not self.email:
            raise ValidationError(_("メールアドレスを入力してください。"))

        if self.email.endswith("@example.com"):
            raise ValidationError(_("example.com ドメインは使用できません。"))

        return super().validate_email()

カスタムバリデーションクラスを使う

from django.core.validators import RegexValidator

class EmailValidator(RegexValidator):
    regex = r"^[^@\s]+@[^@\s]+\.[^@\s]+$"
    message = _("有効なメールアドレスを入力してください。")

# フォーム
class MyForm(forms.Form):
    email = forms.EmailField(validators=[EmailValidator()])

# モデル
class MyModel(models.Model):
    email = models.EmailField(validators=[EmailValidator()])