Fixed #23224 - Documented EmailValidator.
This commit is contained in:
parent
bef5b9b7cd
commit
2a4492aecb
|
@ -544,7 +544,8 @@ The default form widget for this field is a :class:`~django.forms.TextInput`.
|
||||||
|
|
||||||
.. class:: EmailField([max_length=254, **options])
|
.. 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
|
.. versionchanged:: 1.8
|
||||||
|
|
||||||
|
|
|
@ -105,6 +105,35 @@ to, or in lieu of custom ``field.clean()`` methods.
|
||||||
:exc:`TypeError` is raised.
|
:exc:`TypeError` is raised.
|
||||||
Defaults to `0`.
|
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``
|
``URLValidator``
|
||||||
----------------
|
----------------
|
||||||
.. class:: URLValidator([schemes=None, regex=None, message=None, code=None])
|
.. 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
|
.. data:: validate_email
|
||||||
|
|
||||||
An ``EmailValidator`` instance that ensures a value looks like an
|
An :class:`EmailValidator` instance without any customizations.
|
||||||
email address.
|
|
||||||
|
|
||||||
``validate_slug``
|
``validate_slug``
|
||||||
-----------------
|
-----------------
|
||||||
|
|
Loading…
Reference in New Issue