Skip to main content

no more invalid or disposable emails in your database.

Project description

django-email-validators

no more invalid or disposable emails in your database.

Installation

  • Run pip install django-email-validators
  • Add django_email_validators to settings.INSTALLED_APPS
  • Restart your application server

Usage

Validators

  • 🗑️ validate_email_non_disposable
  • 🌐 validate_email_mx
  • ✍️ validate_email_provider_typo
  • 👤 validate_email_unique_dot_insensitive

validate_email_non_disposable

Validates that the email is not from a disposable email provider (fast, offline check).

validate_email_mx

Validates that the email domain has valid MX records (slow, requires network access).

validate_email_provider_typo

Validates that the email domain is not a likely typo of a common email provider. Checks a one-character diff against 80+ common providers and verifies the domain has no valid MX records (prevents false positives).

Examples that will be caught:

  • user@gmai.com -> suggests user@gmail.com
  • user@gmail.co -> suggests user@gmail.com
  • user@yahooo.com -> suggests user@yahoo.com

validate_email_unique_dot_insensitive

Validates that the email is unique in the database, accounting for dot-insensitive providers (e.g. Gmail treats dots in the local part as insignificant, so fabio.caccamo@gmail.com and fabiocaccamo@gmail.com are the same inbox).

Accepts an optional exclude_pk argument to exclude the current user when updating an existing account, and an optional field argument (default: "email") to specify the model field name.

Examples that will be caught:

  • fabio.caccamo@gmail.com already exists → fabiocaccamo@gmail.com is rejected

Since this validator requires access to the model instance (to exclude it on update), it cannot be used directly in a field's validators=[...]. Call it explicitly in a form or serializer:

from django_email_validators import validate_email_unique_dot_insensitive

# Form example
class UserForm(forms.ModelForm):
    def clean_email(self):
        email = self.cleaned_data["email"]
        exclude_pk = self.instance.pk
        validate_email_unique_dot_insensitive(email, exclude_pk=exclude_pk)
        return email

Or via validate_unique on the model:

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

    def validate_unique(self, exclude=None):
        super().validate_unique(exclude=exclude)
        validate_email_unique_dot_insensitive(self.email, exclude_pk=self.pk)

Usage

Note: validate_email_unique_dot_insensitive requires access to the model instance and cannot be used in validators=[...]. See the dedicated section above for usage examples.

from django.db import models
from django_email_validators import (
    validate_email_non_disposable,
    validate_email_mx,
    validate_email_provider_typo,
)

class User(models.Model):
    email = models.EmailField(
        validators=[
            validate_email_non_disposable,
            validate_email_mx,
            validate_email_provider_typo,
        ]
    )

Extending the providers list for typo check

You can extend the list of common email providers used by validate_email_provider_typo by adding your own list in Django settings:

EMAIL_VALIDATORS_EXTEND_COMMON_PROVIDERS = [
    'hey.com',
]

Extending the dot-insensitive domains list

You can extend the list of dot-insensitive domains used by validate_email_unique_dot_insensitive by adding your own list in Django settings:

EMAIL_VALIDATORS_EXTEND_DOT_INSENSITIVE_DOMAINS = [
    'fastmail.com',
]

Testing

# clone repository
git clone https://github.com/fabiocaccamo/django-email-validators.git && cd django-email-validators

# create virtualenv and activate it
python -m venv venv && . venv/bin/activate

# upgrade pip
python -m pip install --upgrade pip

# install requirements
pip install -r requirements.txt -r requirements-test.txt

# install pre-commit to run formatters and linters
pre-commit install --install-hooks

# run tests
tox
# or
pytest

License

Released under MIT License.


Supporting

  • :star: Star this project on GitHub
  • :octocat: Follow me on GitHub
  • :blue_heart: Follow me on Bluesky
  • :moneybag: Sponsor me on Github

See also

  • django-admin-interface - the default admin interface made customizable by the admin itself. popup windows replaced by modals. 🧙 ⚡

  • django-cache-cleaner - clear the entire cache or individual caches easily using the admin panel or management command. 🧹

  • django-colorfield - simple color field for models with a nice color-picker in the admin. 🎨

  • django-extra-settings - config and manage typed extra settings using just the django admin. ⚙️

  • django-maintenance-mode - shows a 503 error page when maintenance-mode is on. 🚧 🛠️

  • django-redirects - redirects with full control. ↪️

  • django-treenode - probably the best abstract model / admin for your tree based stuff. 🌳

  • python-benedict - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. 📘

  • python-codicefiscale - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. 🇮🇹 💳

  • python-fontbro - friendly font operations. 🧢

  • python-fsutil - file-system utilities for lazy devs. 🧟‍♂️

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_email_validators-0.3.0.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_email_validators-0.3.0-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file django_email_validators-0.3.0.tar.gz.

File metadata

  • Download URL: django_email_validators-0.3.0.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for django_email_validators-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3dc616d7fa3b92d514ef151f7bb0c654cda4fe2be7df30837b3edaa3e38d6e36
MD5 8a088eb20b4cd6a3399856c4f9cbe741
BLAKE2b-256 689d9d90e2acbc61060dff35b5aae838f697a4cdf2ca9dca2894290528649ae9

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_email_validators-0.3.0.tar.gz:

Publisher: create-release.yml on fabiocaccamo/django-email-validators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_email_validators-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_email_validators-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a9527b86e98b9d0c06e4d9fc70d087cc92f589d5dac3c6783cb2e02c7d1457a0
MD5 46004be614e7ac82d20b101a0495fd20
BLAKE2b-256 43a973104e7b28beedb3f13e7dd4792b18a8c22e0fedae6834586fc12af84533

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_email_validators-0.3.0-py3-none-any.whl:

Publisher: create-release.yml on fabiocaccamo/django-email-validators

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page