Download the PHP package lucenarenato/laravel-email-domain-blacklist without Composer
On this page you can find all versions of the php package lucenarenato/laravel-email-domain-blacklist. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lucenarenato/laravel-email-domain-blacklist
More information about lucenarenato/laravel-email-domain-blacklist
Files in lucenarenato/laravel-email-domain-blacklist
Package laravel-email-domain-blacklist
Short Description A Laravel package for adding email domain blacklist validation rule
License MIT
Informations about the package laravel-email-domain-blacklist
Laravel/Lumen Email Domain Blacklist
Validate email input that it's not blacklisted for a specific domain name.
Usage
Add blacklist
to the validation rules string.
Installation
Require this package with composer:
This package uses AutoDiscovery.
If you are using Laravel <= 5.4 manually add the Service Provider to the providers array in config/app.php
Publish the package config:
Documentation
Laravel Email Domain Blacklist is a lightweight package that extends your validation rules with blacklist
.
You may pass a local or remote JSON file containing all the blacklisted email domains, usually disposable email services.
If you use a third-party remote list, you may also append your custom email domains.
You may update the cached list with the console command (manually or scheduled).
An auto-update option is available if you don't want to run the command and prefer to auto-update on the first validation.
The validation message translation is available in English and Spanish; feel free to PR your translation.
Laravel validator
Configuration
source: string|null
You may specify the preferred URL or file path to update the blacklist.
Keep null
if you don't want to use a remote source.
Default: https://raw.githubusercontent.com/ivolo/disposable-email-domains/master/index.json
cache-key: string|null
You may change the cache key for the sourced blacklist.
Keep null
if you want to use the default value.
auto-update: true|false
Specify if it should automatically get the source when the cache is empty.
ADVICE: This may slow down the first request upon validation.
Default: false
append: string|null
You may use a string of pipe |
separated domains list.
Keep null
if you don't want to append custom domains.
Example: example.com|example.net|foobar.com
.
Updating the blacklist with command
Manually updating the cached blacklist:
It's OK if you run this command after deployment and refresh it on a weekly/monthly basis.
Scheduling the cached blacklist update (example):
Overriding translation
Add the JSON translation key to your project core translations, which will override the package validation message.
More info on overriding translation
Testing
Projects using this package
I built this package to offload some code in my application Fimedi NET, a clinical nutrition control app for dietitians and patients.
ToDo
- Update the project lexicon to avoid the use of offensive terms.
Contributing
Please try to follow the psr-2 coding style guide. http://www.php-fig.org/psr/psr-2/
Credits
This package was inspired on this great post by Matt Kingshott
- Renato Lucena
- Ilya Volodarsky for maintenance of disposable email domains repo
- At symbol icon made by Gregor Cresnar from www.flaticon.com