Download the PHP package elliotjreed/disposable-emails-filter without Composer
On this page you can find all versions of the php package elliotjreed/disposable-emails-filter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elliotjreed/disposable-emails-filter
More information about elliotjreed/disposable-emails-filter
Files in elliotjreed/disposable-emails-filter
Package disposable-emails-filter
Short Description A PHP package for determining whether an email address is from a disposable / temporary email address provider.
License MIT
Informations about the package disposable-emails-filter
Disposable / Temporary Email Address Filter
This package provides a method for determining whether an email address is a disposable / temporary email address.
All credit to the maintaining of the list of disposable / temporary email addresses goes to github.com/disposable-email-domains/disposable-email-domains.
This project and it's maintainer(s) do not discourage the use of such disposable / temporary email addresses, but simply allows for the detection of such.
Installation
PHP 8.2 or above is required. If PHP 8.1 is required please use version 4. If PHP 7.4 to 8.0 is required please use version 3.
To install via Composer:
Usage
Check if the email address is in the temporary domain list
The checker / filter can either be used via a static or non-static means:
or
List all domains in the temporary email domain list
The lister can either be used via a static or non-static means:
or
If an invalid email address is provided then an InvalidEmailException
is thrown, so it is advisable to check that the email address is valid first. For example:
Would output:
You can also provide your own custom domain list in a new line separated plain-text file, for example:
Then passing the file location into the constructor:
If an invalid list is provided then an InvalidDomainListException
is thrown.
Getting Started with this Repository
PHP 7.4 or above and Composer is expected to be installed on our system.
Installing Composer
For instructions on how to install Composer visit getcomposer.org.
Installing the Package
Installing for Development
After cloning this repository, change into the newly created directory and run
or if you have installed Composer locally
This will install all dependencies needed for the project.
Running the Tests
All tests can be run by executing
phpunit
will automatically find all tests inside the test
directory and run them based on the configuration in the phpunit.xml
file.
Built With
License
This project is licensed under the MIT License - see the LICENCE file for details.