From 2a4492aecb50122f7cc2c643f7ea5b086f301165 Mon Sep 17 00:00:00 2001
From: areski <areski@gmail.com>
Date: Wed, 13 Aug 2014 16:59:58 +0200
Subject: [PATCH] Fixed #23224 - Documented EmailValidator.

---
 docs/ref/models/fields.txt |  3 ++-
 docs/ref/validators.txt    | 32 ++++++++++++++++++++++++++++++--
 2 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 490be14464..d66ee37c47 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -544,7 +544,8 @@ The default form widget for this field is a :class:`~django.forms.TextInput`.
 
 .. class:: EmailField([max_length=254, **options])
 
-A :class:`CharField` that checks that the value is a valid email address.
+A :class:`CharField` that checks that the value is a valid email address. It
+uses :class:`~django.core.validators.EmailValidator` to validate the input.
 
 .. versionchanged:: 1.8
 
diff --git a/docs/ref/validators.txt b/docs/ref/validators.txt
index daa35862c0..42fb44b650 100644
--- a/docs/ref/validators.txt
+++ b/docs/ref/validators.txt
@@ -105,6 +105,35 @@ to, or in lieu of custom ``field.clean()`` methods.
         :exc:`TypeError` is raised.
         Defaults to `0`.
 
+``EmailValidator``
+------------------
+
+.. class:: EmailValidator([message=None, code=None, whitelist=None])
+
+    :param message: If not ``None``, overrides :attr:`.message`.
+    :param code: If not ``None``, overrides :attr:`code`.
+    :param whitelist: If not ``None``, overrides :attr:`whitelist`.
+
+    .. attribute:: message
+
+        The error message used by
+        :exc:`~django.core.exceptions.ValidationError` if validation fails.
+        Defaults to ``"Enter a valid email address"``.
+
+    .. attribute:: code
+
+        The error code used by :exc:`~django.core.exceptions.ValidationError`
+        if validation fails. Defaults to ``"invalid"``.
+
+    .. attribute:: whitelist
+
+        Whitelist of email domains to allow. By default, a regular expression
+        (the ``domain_regex`` attribute) is used to validate whatever appears
+        after the @ sign. However, if that string appears in the whitelist, this
+        validation is bypassed. If not provided, the default whitelist is
+        ``['localhost']``. Other domains that don't contain a dot won't pass
+        validation, so you'd need to whitelist them as necessary.
+
 ``URLValidator``
 ----------------
 .. class:: URLValidator([schemes=None, regex=None, message=None, code=None])
@@ -130,8 +159,7 @@ to, or in lieu of custom ``field.clean()`` methods.
 ------------------
 .. data:: validate_email
 
-    An ``EmailValidator`` instance that ensures a value looks like an
-    email address.
+    An :class:`EmailValidator` instance without any customizations.
 
 ``validate_slug``
 -----------------