usercheck/usercheck-laravel

Laravel validation rule for UserCheck API

v0.1.0 2024-09-22 22:24 UTC

Requires

• php: ^7.4|^8.0
• illuminate/support: ^11.0

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3

MIT

• UserCheck

• email
• validation
• laravel
• disposable
• usercheck

README

A Laravel package for validating email addresses using the UserCheck.com API.

✨ Features

• Block disposable email addresses with an always up-to-date API
• Validate email addresses
• Check for MX records
• Identify personal email addresses
• Customizable validation rules
• Laravel Facade for easy use
• Localization support

Requirements

• PHP 8.0+
• Laravel 11.0+

Installation

Install the package via Composer:

composer require usercheck/usercheck-laravel

Configuration

Add your UserCheck API key to your .env file:

USERCHECK_API_KEY=your_api_key_here

You can obtain a free API key by signing up at https://app.usercheck.com/register.

Usage

Use the usercheck rule in your Laravel validation:

$request->validate([
    'email' => 'required|email|usercheck'
]);

Options

By default, the usercheck rule will only validate the email address's syntax using the UserCheck API. If the email is invalid, the validation will fail.

The usercheck rule accepts several parameters:

• block_disposable: Fails validation if the email is from a disposable email provider
• block_no_mx: Fails validation if the domain has no MX records
• block_public_domain: Fails validation for public email domains (e.g., Gmail, Yahoo). Great to prevent users from signing up with their personal email addresses.
• domain_only: Validates only the domain part of the email. Great for privacy; only the domain will be sent to the API.

You can combine these options to create a custom validation rule.

$request->validate([
    'email' => 'required|email|usercheck:domain_only,block_disposable,block_no_mx',
]);

Using the Facade

You can also use the UserCheck facade directly:

use UserCheck\Laravel\Facades\UserCheck;
$result = UserCheck::validateEmail('[e-mail]');
$result = UserCheck::validateDomain('example.com');

Both methods return an array with is_valid and error_code keys.

Localization

The package includes English translations by default. To customize the error messages, publish the language files:

php artisan vendor:publish --provider="UserCheck\Laravel\UserCheckProvider" --tag="lang"

Then, edit the files in resources/lang/vendor/usercheck.

Testing

Run the tests with:

composer test

Contributing

Contributions are welcome! Please see CONTRIBUTING.md for details.

Security

If you discover any security-related issues, please email [e-mail] instead of using the issue tracker.

License

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

Support

For support, please email [e-mail] or open an issue on GitHub.