Laravel Package

Overview

The UserCheck Laravel Package provides seamless email validation using the UserCheck API. It’s ideal for blocking disposable or spam email addresses and ensuring high-quality user signups in your Laravel applications.

Features

• Block disposable email addresses
• Validate MX records
• Detect spam, aliases, relays, and public domains
• Customizable validation rules
• Supports domain-only checks for privacy
• Built-in Laravel validation rule and Facade
• Localization support

---

Installation

Install via Composer:

composer require usercheck/usercheck-laravel

---

Configuration

Add your API key to .env:

USERCHECK_API_KEY=your_api_key_here

You can get a free API key at app.usercheck.com.

---

Basic Usage

In your form request or controller:

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

This will use UserCheck to validate the email address.

---

Rule Options

You can customize behavior with parameters:

• block_disposable
• block_no_mx
• block_public_domain
• block_relay_domain
• block_spam
• block_blocklisted (Pro only)
• domain_only

Example:

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

---

Facade Usage

use UserCheck\Laravel\Facades\UserCheck;

$result = UserCheck::validateEmail('[email protected]');
$result = UserCheck::validateDomain('example.com');

Returns:

[
    'is_valid' => true,
    'error_code' => null,
]

---

Localization

To customize error messages:

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

Edit translations in resources/lang/vendor/usercheck.

---

Testing

composer test

---

Need Help?

Email us at [email protected] or open an issue on GitHub.