zek/laravel-email-broker

Simple email broker to change email address with confirmation.

dev-main 2023-07-03 00:26 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require zek/laravel-email-broker

You can publish and run the migrations with:

php artisan vendor:publish --tag="email-broker-migrations"
php artisan migrate

Update contents of auth.php:

return [
    'defaults' => [
        'guard' => 'web',
        'emails' => 'users', // <-- Add this line 
    ],
    // ...
    // Add following lines below
    'emails' => [
        'users' => [
            'model' => App\Models\User::class,
            'table' => 'email_changes',
            'expire' => 60, // 60 minutes
            'length' => 6, // Generated token length
        ]
    ],
];

Usage

$EmailBroker = new Zek\EmailBroker();
echo $EmailBroker->echoPhrase('Hello, Zek!');

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.