tebros/laravel-email-confirmation

Email confirmation integration for the Laravel framework.

Laravel E-Mail Confirmation

![Software License][ico-license] , _(*1)

This package integrates an email confirmation into the default laravel authentification., _(*2)

It is has been developed and tested for Laravel 5.5 but it should also work with other versions of Laravel., _(*3)

Installation

Make use of composer to require this package., _(*4)

The installation appends a function call in the routes/web.php file automatically. Please do not comment it out!, _(*5)

composer require tebros/laravel-email-confirmation

Run the make:auth command if not already done., _(*6)

Skip this step if you have already executed the command in the past., _(*7)

php artisan make:auth

Make a migration to create the needed table users_confirmation., _(*8)

```bashneed to php artisan migrate, <sub>(*9)</sub>

Edit the `app/Http/Controllers/Auth/RegisterController.php` file.

The editing is quite simple. 
To hook into the default Laravel authentification prozess, you need to change the `RegistersUsers` trait at the top.

```php
//comment out the line like this or just override it
//use RegistersUsers;

use \Tebros\EmailConfirmation\Traits\RegistersUsers; //use this trait instead of the default

Edit the app/Http/Controllers/Auth/LoginController.php file., <sub>(*10)</sub>

It is required to display correct a message if the account is not confirmed., <sub>(*11)</sub>

//comment out the line like this or just override it
//use AuthenticatesUsers;

use \Tebros\EmailConfirmation\Traits\AuthenticatesUsers; //use this trait instead of the default

Make sure your config/mail.php file contains these important settings: - MAIL_DRIVER - MAIL_HOST - MAIL_PORT - MAIL_USERNAME, MAIL_PASSWORD - MAIL_FROM_ADDRESS, MAIL_FROM_NAME, <sub>(*12)</sub>

Moreover, make sure your config/app.php file contains these important settings: - APP_NAME - APP_URL, <sub>(*13)</sub>

Configuration and Publishing

After the installation you can make use of the confirm route name to link the Resend Confirmation E-Mail site., <sub>(*14)</sub>

Important! You should edit your auth/login.blade.php view and add this link to request a new confirmation email!, <sub>(*15)</sub>

    

        
            Login
        

        
            Forgot Your Password?
        

        
            Resend Confirmation Link?
        
    

If you want to configure the email confirmation, run the following command., <sub>(*16)</sub>

You can modify the config/emailconfirmation.php file as you wish., <sub>(*17)</sub>

php artisan vendor:publish --tag=emailconfirmation-config

To change a message or text you can modify the files in the lang/vendor/emailconfirmation directory., <sub>(*18)</sub>

Run the following command to do this., <sub>(*19)</sub>

php artisan vendor:publish --tag=emailconfirmation-translation

If you do not want to use the default Laravel views, you can modify the views in the views/vendor/emailconfirmation directory., <sub>(*20)</sub>

Run the following command to do this., <sub>(*21)</sub>

php artisan vendor:publish --tag=emailconfirmation-views

Update

You can update the package by running the following command or update all of your dependencies with composer update., <sub>(*22)</sub>

composer update tebros/laravel-email-confirmation

If you want to update your published files like config/emailconfirmation.php, lang/vendor/emailconfirmation or views/vendor/emailconfirmation, you can use the following commands., <sub>(*23)</sub>

Attention! These commands will override your published files. So please backup your config, views or lang files if you do not want to lose them!, <sub>(*24)</sub>

php artisan vendor:publish --tag=emailconfirmation-config --force
php artisan vendor:publish --tag=emailconfirmation-translation --force
php artisan vendor:publish --tag=emailconfirmation-views --force

Uninstallation

You should remove the following two lines in your routes/web.php file., <sub>(*25)</sub>

// Register routes for email confirmation. The uri is "/confirm"
Tebros\EmailConfirmation\Utils::routes();

Edit the app/Http/Controllers/Auth/RegisterController.php file and the app/Http/Controllers/Auth/LoginController.php file to remove the Laravel hook., <sub>(*26)</sub>

//remove the comment that the orifinal trait is used
use RegistersUsers;

//remove the whole line or comment it out
//use \Tebros\EmailConfirmation\Traits\RegistersUsers; 

//remove the comment that the orifinal trait is used
use AuthenticatesUsers;

//remove the whole line or comment it out
//use \Tebros\EmailConfirmation\Traits\AuthenticatesUsers; 

Now just type the following command., <sub>(*27)</sub>

composer remove tebros/laravel-email-confirmation

License

This package is open-sourced software licensed under the MIT license, <sub>(*28)</sub>