邮件验证 – 乌鸦嘴文档中心

介绍

许多网络应用程序要求用户在使用应用程序之前验证他们的电子邮件地址。Laravel 为发送和验证电子邮件验证请求提供了便捷的内置服务，而不是让您为创建的每个应用程序手动重新实现此功能。

[!注意]
想要快速开始吗？在一个新的 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\Events\Registered 事件注册 Illuminate\Auth\Listeners\SendEmailVerificationNotification 监听器。

如果您在应用程序中手动实现注册，而不是使用启动工具包，则应确保在用户注册成功后调度 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。为该路由分配此确切名称非常重要，因为 Laravel 中包含的 verified 中间件如果用户未验证其电子邮件地址，将自动重定向到此路由名称。

[!NOTE]
当手动实现电子邮件验证时，您需要自己定义验证通知视图的内容。如果您想要包含所有必要的身份验证和验证视图的脚手架，请查看 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 事件。默认的 App\Models\User 模型通过 Illuminate\Foundation\Auth\User 基类可以使用 markEmailAsVerified 方法。一旦用户的电子邮件地址已验证，您可以将其重定向到您希望的任何位置。

重新发送验证电子邮件

有时用户可能会放错或意外删除电子邮件地址验证电子邮件。为了适应这种情况，您可能希望定义一个路由，允许用户请求重新发送验证电子邮件。然后，您可以通过在验证通知视图中放置一个简单的表单提交按钮来向此路由发出请求：

use Illuminate\Http\Request;
 
Route::post('/email/verification-notification', function (Request $request) {
    $request->user()->sendEmailVerificationNotification();
 
    return back()->with('message', '验证链接已发送！');
})->middleware(['auth', 'throttle:6,1'])->name('verification.send');

保护路由

路由中间件可用于仅允许已验证的用户访问给定路由。Laravel 包含一个verified中间件别名，它是Illuminate\Auth\Middleware\EnsureEmailIsVerified中间件类的别名。由于此别名已由 Laravel 自动注册，您只需要将verified中间件附加到路由定义中。通常，此中间件与auth中间件配对使用：

Route::get('/profile', function () {
    // 只有已验证的用户可以访问此路由...
})->middleware(['auth', 'verified']);

如果未验证的用户尝试访问已分配此中间件的路由，他们将自动被重定向到verification.notice命名路由。

自定义

验证电子邮件自定义

尽管默认的电子邮件验证通知应满足大多数应用程序的要求，但 Laravel 允许您自定义电子邮件验证邮件的构建方式。

首先，将一个闭包传递给Illuminate\Auth\Notifications\VerifyEmail通知提供的toMailUsing方法。该闭包将接收收到通知的可通知模型实例以及用户必须访问以验证其电子邮件地址的已签名电子邮件验证 URL。该闭包应返回一个Illuminate\Notifications\Messages\MailMessage的实例。通常，您应该从应用程序的AppServiceProvider类的boot方法中调用toMailUsing方法：

use Illuminate\Auth\Notifications\VerifyEmail;
use Illuminate\Notifications\Messages\MailMessage;
 
/**
 * 引导任何应用程序服务。
 */
public function boot(): void
{
    //...
 
    VerifyEmail::toMailUsing(function (object $notifiable, string $url) {
        return (new MailMessage)
            ->subject('验证电子邮件地址')
            ->line('点击下面的按钮以验证您的电子邮件地址。')
            ->action('验证电子邮件地址', $url);
    });
}

[!NOTE]
要了解有关邮件通知的更多信息，请查阅邮件通知文档。

事件

当使用Laravel 应用程序启动工具包时，Laravel 在电子邮件验证过程中会调度一个Illuminate\Auth\Events\Verified事件。如果您为应用程序手动处理电子邮件验证，您可能希望在验证完成后手动调度这些事件。

授权加密