Подтверждение адреса электронной почты

Введение

Многие веб-приложения требуют от пользователей подтверждения своего адреса электронной почты перед использованием приложения. Вместо того чтобы заставлять вас самостоятельно реализовывать этот функционал повторно для каждого создаваемого вами приложения, Laravel предлагает удобные встроенные службы для отправки и проверки запросов подтверждения адреса электронной почты.

Хотите быстро начать? Установите один из стартовых комплектов в новое приложение Laravel. Стартовые комплекты позаботятся о построении всей вашей системы аутентификации, включая поддержку подтверждения электронной почты.

Подготовка модели

Убедитесь, что ваша модель App\Models\User реализует контракт Illuminate\Contracts\Auth\MustVerifyEmail:

<?php

namespace App\Models;

use Illuminate\Contracts\Auth\MustVerifyEmail;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable implements MustVerifyEmail
{
    use Notifiable;

    // ...
}

Как только этот интерфейс будет добавлен в вашу модель, вновь зарегистрированным пользователям будет автоматически отправлено электронное письмо со ссылкой для подтверждения адреса электронной почты. Это происходит легко, потому что Laravel автоматически регистрирует Illuminate\Auth\Listeners\SendEmailVerificationNotification слушатель для события Illuminate\Auth\Events\Registered.

Если вы самостоятельно выполняете регистрацию в своем приложении вместо использования стартового комплекта, то вы должны убедиться, что запускаете событие Illuminate\Auth\Events\Registered после успешной регистрации пользователя:

use Illuminate\Auth\Events\Registered;

event(new Registered($user));

Подготовка базы данных

Ваша таблица users должна содержать столбец email_verified_at для сохранения даты и времени подтверждения адреса электронной почты пользователем. Обычно это включено в миграцию базы данных Laravel 0001_01_01_000000_create_users_table.php по умолчанию.

Маршрутизация

Чтобы правильно реализовать подтверждение электронной почты, необходимо определить три маршрута. Во-первых, потребуется маршрут для отображения уведомления пользователю о том, что он должен щелкнуть ссылку подтверждения электронной почты в письме, которое Laravel отправит ему после регистрации.

Во-вторых, потребуется маршрут для обработки запросов, сгенерированных, когда пользователь щелкает ссылку подтверждения электронной почты в электронном письме.

В-третьих, потребуется маршрут для повторной отправки ссылки для подтверждения, если пользователь случайно потеряет первую ссылку для подтверждения.

Уведомление о подтверждении электронной почты

Как упоминалось ранее, должен быть определен маршрут, возвращающий страницу, инструктирующую пользователя щелкнуть ссылку для подтверждения электронной почты, которая была отправлена ему Laravel по электронной почте после регистрации. Эта страница будет отображаться для пользователей, когда они попытаются получить доступ к другим частям приложения без предварительной проверки своего адреса электронной почты. Помните, что ссылка автоматически отправляется пользователю по электронной почте, если ваша модель App\Models\User реализует интерфейс MustVerifyEmail:

Route::get('/email/verify', function () {
    return view('auth.verify-email');
})->middleware('auth')->name('verification.notice');

Маршрут, который возвращает уведомление о подтверждении по электронной почте, должен называться verification.notice. Важно, чтобы маршруту было присвоено это точное имя, поскольку посредник verify, включенный в Laravel, будет автоматически перенаправлять на это имя маршрута, если пользователь не подтвердил свой адрес электронной почты.

При выполнении проверки электронной почты самостоятельно, вам необходимо определить содержание страницы уведомления о проверке. Если вам необходим каркас, включающий все необходимые страницы для аутентификации и проверки, ознакомьтесь со стартовыми комплектами приложений Laravel.

Обработчик проверки электронной почты

Затем, нам нужно определить маршрут, обрабатывающий запросы, сгенерированные, когда пользователь щелкает ссылку подтверждения электронной почты, которая была отправлена ему по электронной почте. Этот маршрут должен называться verification.verify и ему должны быть назначены посредники auth и signed:

use Illuminate\Foundation\Auth\EmailVerificationRequest;

Route::get('/email/verify/{id}/{hash}', function (EmailVerificationRequest $request) {
    $request->fulfill();

    return redirect('/home');
})->middleware(['auth', 'signed'])->name('verification.verify');

Прежде чем двигаться дальше, давайте подробнее рассмотрим этот маршрут. Во-первых, вы заметите, что мы используем тип запроса EmailVerificationRequest вместо типичного экземпляра Illuminate\Http\Request. EmailVerificationRequest – это запрос формы, который включен в Laravel. Этот запрос автоматически позаботится о проверке параметров запроса id и hash.

Далее, мы можем приступить непосредственно к вызову метода fulfill запроса. Этот метод вызовет метод markEmailAsVerified для аутентифицированного пользователя и запустит событие Illuminate\Auth\Events\Verified. Метод markEmailAsVerified доступен для модели по умолчанию App\Models\User через базовый класс Illuminate\Foundation\Auth\User. После подтверждения адреса электронной почты пользователя вы можете перенаправить его куда пожелаете.

Повторная отправка письма с подтверждением

Иногда пользователь может потерять или случайно удалить письмо с подтверждением адреса электронной почты. Чтобы учесть это, вы можете определить маршрут, позволяющий пользователю запрашивать повторную отправку письма с подтверждением. Затем, вы можете сделать запрос по этому маршруту, поместив простую кнопку отправки формы на странице уведомления о подтверждении:

use Illuminate\Http\Request;

Route::post('/email/verification-notification', function (Request $request) {
    $request->user()->sendEmailVerificationNotification();

    return back()->with('message', 'Verification link sent!');
})->middleware(['auth', 'throttle:6,1'])->name('verification.send');

Защита маршрутов

Middleware может использоваться для разрешения доступа только для проверенных пользователей к определенному маршруту. Laravel включает verified псевдоним middleware, который является псевдонимом для класса middleware Illuminate\Auth\Middleware\EnsureEmailIsVerified. Поскольку этот псевдоним уже автоматически зарегистрирован Laravel, все, что вам нужно сделать, это прикрепить verified middleware к определению маршрута. Обычно этот middleware используется вместе с middleware auth:

Route::get('/profile', function () {
    // Только подтвержденные пользователи могут получить доступ к этому маршруту ...
})->middleware(['auth', 'verified']);

Если непроверенный пользователь попытается получить доступ к маршруту, которому назначен этот посредник, то он будет автоматически перенаправлен на именованный маршрут verification.notice.

Настройка

Настройка подтверждения адреса электронной почты

Хотя уведомление о подтверждении электронной почты по умолчанию должно удовлетворять требованиям большинства приложений, Laravel позволяет вам изменить сообщение подтверждения электронной почты.

Для начала, передайте замыкание методу toMailUsing уведомления Illuminate\Auth\Notifications\VerifyEmail. Замыкание получит экземпляр модели, содержащий уведомление, а также подписанный URL-адрес подтверждения электронной почты, который пользователь должен посетить для проверки адреса электронной почты. Замыкание должно вернуть экземпляр Illuminate\Notifications\Messages\MailMessage. Как правило, вызов метода toMailUsing осуществляется в методе boot класса AppServiceProvider вашего приложения:

use Illuminate\Auth\Notifications\VerifyEmail;
use Illuminate\Notifications\Messages\MailMessage;

/**
 * Bootstrap any application services.
 */
public function boot(): void
{
    // ...

    VerifyEmail::toMailUsing(function (object $notifiable, string $url) {
        return (new MailMessage)
            ->subject('Verify Email Address')
            ->line('Click the button below to verify your email address.')
            ->action('Verify Email Address', $url);
    });
}

Чтобы узнать больше о почтовых уведомлениях, обратитесь к документации по почтовым уведомлениям.

События

При использовании стартовых комплектов Laravel запускает Illuminate\Auth\Events\Verified событие в процессе проверки электронной почты. Если вы самостоятельно обрабатываете проверку электронной почты для своего приложения, то вы должны запускать эти события после завершения проверки.