Djangoでメールアドレスバリデーションを徹底強化：EmailValidator.allowlistと正規表現の組み合わせ

Django の EmailValidator.allowlist 詳細解説

django.core.validators.EmailValidator.allowlist は、Django のフォームバリデーション機能で利用できるオプションです。これは、ユーザーが入力したメールアドレスのドメイン部分が、指定されたリストに含まれているかどうかをチェックします。

デフォルトの動作

EmailValidator は、デフォルトで正規表現を使用してメールアドレスのドメイン部分を検証します。この正規表現は、一般的なトップレベルドメイン (TLD) を含む、ほとんどの有効なドメインと一致します。

allowlist オプションを使用すると、特定のドメインからのメールアドレスのみを許可することができます。例えば、以下のコードは、gmail.com と yahoo.com からのメールアドレスのみを許可します。

from django.core.validators import EmailValidator

email_validator = EmailValidator(allowlist=['gmail.com', 'yahoo.com'])

# '[email protected]' は有効
email_validator.validate('[email protected]')

# '[email protected]' は無効
email_validator.validate('[email protected]')

allowlist の利点

• 特定の組織からのメールアドレスのみを受け付けるようにフォームを制限できます。
• スパムやフィッシング詐欺を防ぐのに役立ちます。

allowlist の注意点

• allowlist には、必ずしもすべての有効なドメインを含める必要はありません。
• allowlist に含まれていないドメインからのメールアドレスは、すべて無効とみなされます。

その他のオプション

• EmailValidator には、message と code という 2 つのオプションも存在します。
• message は、バリデーションエラーが発生した際に表示されるメッセージです。
• code は、バリデーションエラーが発生した際に返されるエラーコードです。

補足

• allowlist は、Django 3.2.20 で導入されました。
• Django 4.1 では、whitelist オプションは非推奨になりました。代わりに allowlist オプションを使用する必要があります。

EmailValidator.allowlist を使用したサンプルコード

from django.core.validators import EmailValidator

email_validator = EmailValidator(allowlist=['gmail.com', 'yahoo.com'])

# '[email protected]' は有効
email_validator.validate('[email protected]')

# '[email protected]' は無効
email_validator.validate('[email protected]')

allowlist を動的に設定する

from django.core.validators import EmailValidator

def get_allowlist():
    # データベースから許可ドメインのリストを取得
    return ['example.com', 'another-example.com']

email_validator = EmailValidator(allowlist=get_allowlist())

# '[email protected]' は有効
email_validator.validate('[email protected]')

# '[email protected]' は無効
email_validator.validate('[email protected]')

カスタムメッセージを設定する

from django.core.validators import EmailValidator

email_validator = EmailValidator(
    allowlist=['gmail.com', 'yahoo.com'],
    message="このドメインからのメールアドレスは無効です。",
)

try:
    email_validator.validate('[email protected]')
except ValidationError as e:
    print(e.messages)

出力:

['このドメインからのメールアドレスは無効です。']

カスタムエラーコードを設定する

from django.core.validators import EmailValidator

email_validator = EmailValidator(
    allowlist=['gmail.com', 'yahoo.com'],
    code='invalid_domain',
)

try:
    email_validator.validate('[email protected]')
except ValidationError as e:
    print(e.code)

出力:

invalid_domain

allowlist と excludelist の併用

from django.core.validators import EmailValidator

email_validator = EmailValidator(
    allowlist=['gmail.com'],
    excludelist=['yahoo.com'],
)

# '[email protected]' は有効
email_validator.validate('[email protected]')

# '[email protected]' は無効
email_validator.validate('[email protected]')

# '[email protected]' は無効
email_validator.validate('[email protected]')

正規表現と allowlist の併用

from django.core.validators import EmailValidator

email_validator = EmailValidator(
    regex=r'^.+@example\.com$',
    allowlist=['gmail.com'],
)

# '[email protected]' は有効
email_validator.validate('[email protected]')

# '[email protected]' は無効
email_validator.validate('[email protected]')

# '[email protected]' は無効
email_validator.validate('[email protected]')

これらのサンプルコードは、EmailValidator.allowlist オプションの使用方法を理解するのに役立ちます。

EmailValidator.allowlist 以外の方法

カスタムバリデーション関数

django.forms.ValidationError を発生させるカスタムバリデーション関数を定義することができます。

def validate_email_domain(value):
    allowed_domains = ['gmail.com', 'yahoo.com']
    if value.split('@')[-1] not in allowed_domains:
        raise ValidationError("このドメインからのメールアドレスは無効です。")

# forms.py

from django import forms

class MyForm(forms.Form):
    email = forms.EmailField(validators=[validate_email_domain])

RegexValidator

django.core.validators.RegexValidator を使用して、ドメイン部分に一致する正規表現を定義することができます。

from django.core.validators import RegexValidator

email_validator = RegexValidator(
    regex=r'^.+@example\.com$',
    message="このドメインからのメールアドレスは無効です。",
)

# forms.py

from django import forms

class MyForm(forms.Form):
    email = forms.EmailField(validators=[email_validator])

ModelChoiceField

django.forms.ModelChoiceField を使用して、許可ドメインのリストをデータベースから取得することができます。

from django.db import models

class Domain(models.Model):
    name = models.CharField(max_length=255)

# forms.py

from django import forms

class MyForm(forms.Form):
    email = forms.ModelChoiceField(
        queryset=Domain.objects.all(),
        to_field_name='name',
    )

これらの方法は、EmailValidator.allowlist オプションよりも柔軟性がありますが、コード量が増える場合があります。