emailreputationapi/reputation

A Laravel package for the EmailReputationAPI.com service.

0.0.2 2023-08-10 03:29 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^10.0
• spatie/laravel-package-tools: ^1.14.0

Requires (Dev)

• laravel/pint: ^1.0
• nunomaduro/collision: ^7.8
• orchestra/testbench: ^8.0
• pestphp/pest: ^2.0
• pestphp/pest-plugin-arch: ^2.0
• pestphp/pest-plugin-laravel: ^2.0

MIT

• Jason Gilmore

• laravel
• EmailReputationAPI.com
• laravel-reputation

README

EmailReputationAPI.com is a service that helps sales teams more effectively filter and segment leads by identifying personal and disposable email addresses and domains. You can use this Laravel package to easily plug into the EmailReputation API validation service and database.

Installation

You can install the package via Composer:

composer require emailreputationapi/reputation

You can publish the config file with:

$ php artisan vendor:publish --tag="reputation-config"

This is the contents of the published config file (config/reputation.php):

return [
    'api_key' => env('EMAIL_REPUTATION_API_SECRET'),
    'api_url' => env('EMAIL_REPUTATION_API_URL'),
];

Open your .env file and add the following section:

# EmailReputationAPI.com
EMAIL_REPUTATION_API_SECRET='YOUR_EMAIL_REPUTATION_API_SECRET_KEY'
EMAIL_REPUTATION_API_URL='https://emailreputationapi.com/api/v1/validate'

Usage

$era = new EmailReputationAPI\Reputation\Email;
$valid = $era->validate('[e-mail]');
= {#6227
    +"email": "[e-mail]",
    +"syntax": "valid",
    +"tld": "true",
    +"personal": "false",
    +"disposable": "false",
    +"business": "false",
    +"government": "false",
    +"unknown": "true",
  }

Security Vulnerabilities

Please email [e-mail]