README

A comprehensive Laravel package for advanced email validation combining RFC compliance checks, DNS/MX record verification, and disposable email detection. Built on top of egulias/email-validator and propaganistas/laravel-disposable-email.

Features

RFC Syntax Validation: Validates email format against RFC 5321, 5322, 6530, 6531, 6532, and 1035
DNS/MX Record Verification: Checks if the email domain has valid MX records
Disposable Email Detection: Blocks temporary/disposable email providers
Configurable Validations: Enable/disable specific validation checks via config
Custom Error Messages: Customize validation error messages
Facade Support: Easy access via Laravel facade

Installation

You can install the package via composer:

composer require eg-mohamed/email-validation

Optionally, you can publish the config file with:

php artisan vendor:publish --tag="email-validation-config"

This is the contents of the published config file:

return [
    'validations' => [
        'syntax' => true,
        'dns' => true,
        'disposable' => true,
    ],
];

You can also publish the translations:

php artisan vendor:publish --tag="email-validation-translations"

The package includes English and Arabic translations by default.

Usage

Using the Validation Rule

You can use the email_validation rule in your validation rules:

use Illuminate\Http\Request;

public function store(Request $request)
{
    $validated = $request->validate([
        'email' => ['required', 'email_validation'],
    ]);
}

Using the Rule Class

You can also use the rule class directly:

use MohamedSaid\EmailValidation\Rules\EmailValidationRule;

$request->validate([
    'email' => ['required', new EmailValidationRule()],
]);

Using the Facade

The package provides a facade for programmatic validation:

use MohamedSaid\EmailValidation\Facades\EmailValidation;

if (EmailValidation::isValid('user@example.com')) {
    // Email is valid
}

$results = EmailValidation::validate('user@example.com');

$failures = EmailValidation::getFailures('user@example.com');

Configuration

You can control which validations are performed by modifying the config file:

return [
    'validations' => [
        'syntax' => true,      // RFC syntax validation
        'dns' => true,         // DNS/MX record check
        'disposable' => true,  // Disposable email detection
    ],
];

Custom Error Messages

Customize the error messages by publishing and editing the translation files:

English (lang/en/email-validation.php):

return [
    'syntax' => 'The :attribute must be a valid email address.',
    'dns' => 'The :attribute domain does not have valid MX records.',
    'disposable' => 'Disposable email addresses are not allowed.',
];

Arabic (lang/ar/email-validation.php):

return [
    'syntax' => 'يجب أن يكون :attribute عنوان بريد إلكتروني صالح.',
    'dns' => 'نطاق :attribute لا يحتوي على سجلات MX صالحة.',
    'disposable' => 'عناوين البريد الإلكتروني المؤقتة غير مسموح بها.',
];

Validation Order

Validations are performed in the following order for optimal performance:

Syntax validation (fastest)
Disposable email check (medium)
DNS/MX verification (slowest)

The validation stops at the first failure to minimize processing time.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

eg-mohamed / email-validation

Maintainers

Details