Django package to detect ~890 domains used by disposable email services
Project description
=============================== django-disposable-email-checker
Django package to detect between ~890 & ~8,600 domains used by disposable email services. You can validate any email against our internal list of ~890 domains used by disposable email services. Optionally you can also check each domain against the Block-Disposable-Email.com API, covering ~8,600 domains.
This code was initially developed at: https://github.com/aaronbassett/DisposableEmailChecker However PyPI ownership has been transferred to https://github.com/jheld/DisposableEmailChecker and as such all future contributions are expected to be made to the new github repo.
Setup
Install the disposable email checker from PyPI
pip install django-disposable-email-checker
The disposable email checker comes with a list of ~890 emails. If you would like to provide your own email list create a function which returns a list of domains to block.
from disposable_email_checker.emails import email_domain_loader
def custom_email_domain_loader():
# Anyone still using AOL will be too much of a customer service burden
return [
"aol.com",
] + email_domain_loader()
Then add the complete path including function name to your settings
DEC_LOADER = "my.package.custom_email_domain_loader"
If you would like to use the BDE integration add your API key to your Django settings
BDEA_APIKEY = "abcnotarealkey123"
optionally you can configure the BDE API timeout in seconds (default 5)
BDEA_TIMEOUT = 2
A default error message can be set globally for the validation checking (this is optional and if
left blank it will default to _('Blocked email provider.')
):
BDEA_MESSAGE = '<blocked email message>'
Adding to your models
Once you have completed setup add the DisposableEmailField
to your models.
from django.db import models
from disposable_email_checker.fields import DisposableEmailField
class MyModel(models.Model):
email = DisposableEmailField()
The DisposableEmailField
has a few optional arguments
- whitelist - A list of emails which will always be allowed. Defaults
to
[]
- message - The error message used by ValidationError if validation
fails. Defaults to
_('Blocked email provider.')
- code - The error code used by ValidationError if validation fails. Defaults to "invalid".
Using the validator
If you want to use the validator by itself
from django.core.exceptions import ValidationError
from disposable_email_checker.validators import validate_disposable_email
email = "emailaddress@readmetest.com" # replace with your own value
try:
validate_disposable_email(email)
except ValidationError:
pass
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-disposable-email-checker-2.0.3a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cc11a6e01afdfe6470719efec023e1c413935c4d359826003a8c050abedc32dc |
|
MD5 | 1e8b367926edb9f3cddbd4610ed5098f |
|
BLAKE2b-256 | 0c66a20be7551c8640fb883e9fab57222038f90bb2135a2e5932b74d439b01a4 |
Hashes for django_disposable_email_checker-2.0.3a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4aaa1a581e25e3f7e668fe1cf1a10e6f9bc74afb56cddb8f19049c0ac53b204 |
|
MD5 | 01141f0c2b0851f64e571df98ba10637 |
|
BLAKE2b-256 | 7427e2e966b6df3f9ca8e7edab65c2cdc5fec1d7569b9861cf4ec39b115dbc6b |