Document EmailValidator domain whitelist parameter

[egberts]

I am unable to validate "webmaster@lab" email address using EmailField() validator.

Examination of Test framework (TEST_DATA in tests.py) shows that it won't take the "abc@bar" email format.

TEST_DATA =
...
 (validate_email, 'abc@bar', ValidationError)
...

Did I miss something new amongst the vast IETF specifications regarding this new restrictive email syntax? Or must we expand our 20yo Lab domain name to something like 'lab.test'?

Tarball File Used: django-django-1.7a3-1364-gedcc75e.zip

[Collin Anderson]

as a data point: yes, django 1.6 gives the same error message

>>> from django import forms
>>> forms.EmailField().clean('webmaster@lab')
ValidationError: [u'Enter a valid email address.']

[Areski Belaid]

FYI this is where django implement the email validation: ​https://github.com/django/django/blob/master/django/core/validators.py#L119
documentation on validators: ​https://docs.djangoproject.com/en/dev/ref/forms/validation/#using-validation-in-practice

From this, you will notice that there is an easy way to validate abc@bar:

from django.forms import EmailField
from django.core.validators import EmailValidator

class MyEmailField(EmailField):
    default_validators = [EmailValidator(whitelist=['bar'])]

MyEmailField().clean('abc@bar')

[Tim Graham]

We should document the solution described by areski.

[Areski Belaid]

Here a PR for to document the solution ​https://github.com/django/django/pull/3056

[Tim Graham <timograham@…>]

In 2a4492aecb50122f7cc2c643f7ea5b086f301165:

Fixed #23224 - Documented EmailValidator.