danikp/laravel-email-verification

Laravel package to handle user verification using an activation mail

Introduction

The Laravel Email Verification package is built for Laravel 5.4 to easily handle a user verification and validate the e-mail. It is inspired by Laravel's 5.5 crypto-based password reset functionality and the email verification package by jrean.

• Crypto-based email verification. No need to store a temporary token in the database!
• Event based: No need to override your register() method.
• Using the Laravel 5.3 notification system.
• Allow certain routes for verified users only using the IsEmailVerified middleware.
• Resend the verification email anytime.

Configuration

To get started, use Composer to add the package to your project's dependencies:

composer require josiasmontag/laravel-email-verification

After installing the email verification package, register the Lunaweb\EmailVerification\Providers\EmailVerificationServiceProvider in your config/app.php configuration file:

'providers' => [
    // Other service providers...

    Lunaweb\EmailVerification\Providers\EmailVerificationServiceProvider::class,
],

Migration

The table representing the user must be updated with a verified column. This update will be performed by the migrations included with this package.

To run the migrations from this package use the following command:

php artisan migrate --path="/vendor/josiasmontag/laravel-email-verification/resources/migrations"

The package tries to guess your user table by checking what is set in the auth providers users settings. If this key is not found, the default App\User will be used to get the table name.

To customize the migration, publish it with the following command:

php artisan vendor:publish --provider="Lunaweb\EmailVerification\EmailVerificationServiceProvider" --tag="migrations"

User Model

The model representing the User must implement the CanVerifyEmail interface. The package comes with a CanVerifyEmail trait for a quick implementation. You can customize this trait in order to change the activation email.

use Lunaweb\EmailVerification\Traits\CanVerifyEmail;
use Lunaweb\EmailVerification\Contracts\CanVerifyEmail as CanVerifyEmailContract;

class User implements CanVerifyEmailContract
{

    use CanVerifyEmail;

    // ...
}

Register Controller

The package offers a VerifiesEmail trait for your RegisterController. You must update the middleware exception to allow verify routes to be access by authenticated users.

use Lunaweb\EmailVerification\Traits\VerifiesEmail;
use Lunaweb\User\Http\Controllers\Controller;

class RegisterController extends Controller
{

    use RegistersUsers, VerifiesEmail;


    public function __construct()
    {
        $this->middleware('guest', ['except' => ['verify']]);
    }

    // ...

}

There is no need to override register(). As default, the package listens for the Illuminate\Auth\Events\Registered event and sends the verification mail. You can disable this behavior using the listen_registered_event setting.

The package adds one route vor the email verification link.

Route::get('register/verify', 'App\Http\Controllers\Auth\RegisterController@verify');

Middleware

To register the IsEmailVerified middleware add the following to the $routeMiddleware array within the app/Http/Kernel.php file:

protected $routeMiddleware = [
    // …
    'isEmailVerified' => \Lunaweb\EmailVerification\Middleware\IsEmailVerified::class,

Apply the middleware on your routes:

Route::group(['middleware' => ['web', 'auth', 'isEmailVerified']], function () {
    …

Events

The package emits 2 events:

• Lunaweb\EmailVerification\Events\EmailVerificationSent
• Lunaweb\EmailVerification\Events\UserVerified

Resend the verification mail

$this->app->make('Lunaweb\EmailVerification\EmailVerification')->sendVerifyLink($user);