File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	Laravel Active Email Validate email to reject disposable addresses
Author:	By Victor John Ukam
Last change:
Date:	3 months ago
Size:	`5,872 bytes`

Download

laravel-active-email

Overview - Key Features
Installation - Requirements - Install the Package - Publish the Config
Usage - Validator Approach - Class Approach - Customization - Strict Mode - Black List - Grey List - White List - Error Message
Testing
To do
Security
Contribution
Changelog
Upgrading
License

Overview

This package provides a library of disposable domains and adds a validator to Laravel apps to check that a given email address isn't coming from a disposable email service such as Mailinator, Guerillamail, Tempmail considering all their possible wildcards.

Key Features

You can add your own preferred domains to the black list.
You can white list a domain to bye pass the blacklist. This can be useful in development environment.
With strict mode, you can control the strictness of the validator, thereby allowing or preventing domains that are not necessarily disposable, but have been classified as disposable.
Case-aware.
Wildcard-aware.

Installation

Requirements

The package has been developed and tested to work with the following minimum requirements:

PHP 8.x
Laravel 10.x and above.

Install the Package

You can install the package via Composer. The service provider is discovered automatically.

composer require veeqtoh/laravel-active-email

Publish the Config

You can then publish the package's config file and update it as you'd prefer:

php artisan vendor:publish --provider="Veeqtoh\ActiveEmail\Providers\ActiveEmailProvider"

Usage

Validator Approach

Add the notblacklisted validator to your email validation rules array (or string) to ensure that the domain for a given email address is not blacklisted. I'd recommend you add it after the email validator to make sure a valid email is passed through:

'emailField' => 'email|notblacklisted',

'emailField' => ['email', 'notblacklisted'],

Class Approach

Instantiate the NotBlackListedEmail Class as part of your email validation rules array to ensure that the domain for a given email address is not blacklisted. Again, I'd recommend you add it after the email validator to make sure a valid email is passed through:

use Veeqtoh\ActiveEmail\Rules\NotBlackListedEmail;

'emailField' => ['email', new NotBlackListedEmail()],

Customization

The package is highly customizable from the config file with the following features:

Strict Mode

This value determines the strictness level of this feature. when set to true, domains in the grey list are also blacklisted.

It is turned on by default, but can be set in your .env file as follows:

DISPOSABLE_EMAIL_STRICT_MODE=true,

Black List

This is a list of base domains with or without the TLD that are blacklisted by default. Add a domain to this list to blacklist it.

Grey List

This is a list of base domains with or without the TLD that aren't blacklisted by default except when in strict mode. Add a domain to this list to whitelist it when the feature is not set to strict mode. Ensure that the domain is not on the black list.