DisposableEmailChecker
======================

Python class for use with Django to detect Disposable Emails
DisposableEmailChecker
======================

Python class for use with Django to detect Disposable Emails. Checks each email against a blacklist of ~890 domains used by various disposable email services.


## Installation

    pip install git+ssh://git@github.com/aaronbassett/DisposableEmailChecker.git
    

Download the example disposable email domains list or create your own and update `settings.py`

    cd /usr/share/
    wget https://raw.github.com/aaronbassett/DisposableEmailChecker/master/disposable_email_domains.txt
    
## Required Setting

    DISPOSABLE_EMAIL_DOMAINS = "/usr/share/disposable_email_domains.txt"


## Usage
    >>> from disposable_email_checker import DisposableEmailChecker
    
    >>> email_checker = DisposableEmailChecker()
    >>> email_checker.is_disposable("foo@guerrillamail.com")
    True


## Using with Django

    from django import forms
    from django.utils.translation import ugettext_lazy as _
    from disposable_email_checker import DisposableEmailChecker
    
    
    class MyForm(forms.Form):
        email = forms.EmailField(label=_('Email'))
    
        def clean_email(self):
            email_checker = DisposableEmailChecker()
            if email_checker.is_disposable(email):
                raise forms.ValidationError(_('Please use a different email address provider.'))
    
            return email

## License

MIT: http://aaron.mit-license.org
Update Read Me with installation and usage
Update Read Me with installation and usage
