Laravel 5.3郵件發(fā)送擴(kuò)展：自定義數(shù)據(jù)庫郵件日誌

Laravel 5.3 提供了一種簡單的方法來配置和通過多種流行服務(wù)發(fā)送電子郵件，並包含一個用於開發(fā)的日誌輔助程序。然而，它並不涵蓋所有可用的服務(wù)，因此可能需要擴(kuò)展現(xiàn)有的郵件驅(qū)動程序系統(tǒng)。

關(guān)鍵要點(diǎn)：

• Laravel 5.3 提供了通過多種流行服務(wù)輕鬆配置和發(fā)送電子郵件的簡便方法，並包含用於開發(fā)的日誌輔助程序。但是，它並不涵蓋所有可用的服務(wù)，因此可能需要擴(kuò)展現(xiàn)有的郵件驅(qū)動程序系統(tǒng)。
• 要擴(kuò)展郵件驅(qū)動程序系統(tǒng)，可以使用 artisan 命令行助手創(chuàng)建一個新的服務(wù)提供程序。此服務(wù)提供程序在啟動時與應(yīng)用程序交互並註冊服務(wù)。
• 新的服務(wù)提供程序可以擴(kuò)展現(xiàn)有的 IlluminateMailMailServiceProvider，允許 register 方法已被實現(xiàn)。這允許創(chuàng)建新的傳輸管理器，該管理器可以將 Swift mailer 實例綁定到容器。
• 擴(kuò)展的郵件驅(qū)動程序系統(tǒng)可用於將電子郵件記錄到數(shù)據(jù)庫表中以進(jìn)行調(diào)試。這是通過為數(shù)據(jù)庫表創(chuàng)建一個新的遷移和一個新的模型來與表交互來實現(xiàn)的。然後將提供程序添加到 config/app.php 文件中的提供程序列表中，並將郵件驅(qū)動程序註冊到 config/mail.php 文件中的 db 中。

Laravel 提供了許多實用功能，其中包括郵件發(fā)送功能。您可以輕鬆配置並通過多種流行服務(wù)發(fā)送電子郵件，它甚至包含用於開發(fā)的日誌輔助程序。

Mail::send('emails.welcome', ['user' => $user], function ($m) use ($user) {
    $m->to($user->email, $user->name)->subject('Welcome to the website');
});

這將使用 emails.welcome 視圖向網(wǎng)站上的新註冊用戶發(fā)送電子郵件。使用 Laravel 5.3 中的 Mailable，它變得更加簡單（但舊語法仍然有效）。

以下是一個示例：

# 生成一個新的可郵件類
php artisan make:mail WelcomeMail

// app/Mail/WelcomeMail.php

class WelcomeUser extends Mailable
{
    use Queueable, SerializesModels;

    public $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }

    public function build()
    {
        return $this->view('emails.welcome');
    }
}

// routes/web.php

Route::get('/', function () {
    $user = User::find(2);

    \Mail::to($user->email)->send(new WelcomeUser($user));

    return "done";
});

Laravel 還提供了一個良好的起點(diǎn)，用於在開發(fā)階段使用日誌驅(qū)動程序發(fā)送郵件，在生產(chǎn)階段使用 smtp、sparkpost、mailgun 等。在大多數(shù)情況下，這似乎很好，但它無法涵蓋所有可用的服務(wù)！在本教程中，我們將學(xué)習(xí)如何擴(kuò)展現(xiàn)有的郵件驅(qū)動程序系統(tǒng)以添加我們自己的驅(qū)動程序。

為了使我們的示例簡單明了，我們將郵件日誌記錄到數(shù)據(jù)庫表中。

創(chuàng)建服務(wù)提供程序

實現(xiàn)此目的的首選方法是創(chuàng)建一個服務(wù)提供程序，以便在啟動時與我們的應(yīng)用程序交互並註冊我們的服務(wù)。讓我們首先使用 artisan 命令行助手生成一個新的服務(wù)提供程序。

Mail::send('emails.welcome', ['user' => $user], function ($m) use ($user) {
    $m->to($user->email, $user->name)->subject('Welcome to the website');
});

這將在我們的 app/Providers 文件夾中創(chuàng)建一個新的類。如果您熟悉 Laravel 服務(wù)提供程序，您將知道我們擴(kuò)展了 ServiceProvider 類並定義了 boot 和 register 方法。您可以在文檔中閱讀更多關(guān)於提供程序的信息。

使用郵件提供程序

與其使用父服務(wù)提供程序類，我們可以採取捷徑並擴(kuò)展現(xiàn)有的 IlluminateMailMailServiceProvider。這意味著 register 方法已實現(xiàn)。

# 生成一個新的可郵件類
php artisan make:mail WelcomeMail

registerSwiftMailer 方法將根據(jù) mail.driver 配置值返回相應(yīng)的傳輸驅(qū)動程序。我們在這裡可以做的是在調(diào)用 registerSwiftMailer 父方法之前執(zhí)行檢查並返回我們自己的 傳輸管理器。

// app/Mail/WelcomeMail.php

class WelcomeUser extends Mailable
{
    use Queueable, SerializesModels;

    public $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }

    public function build()
    {
        return $this->view('emails.welcome');
    }
}

使用傳輸管理器

Laravel 從 IOC 解析 swift.mailer 實例，它應(yīng)該返回 Swift_Mailer 的 SwiftMailer 實例。我們需要將我們的 Swift mailer 實例綁定到容器。

// routes/web.php

Route::get('/', function () {
    $user = User::find(2);

    \Mail::to($user->email)->send(new WelcomeUser($user));

    return "done";
});

您可以將傳輸對象視為實際的驅(qū)動程序。如果您檢查 IlluminateMailTransport 命名空間，您會發(fā)現(xiàn)每個驅(qū)動程序的不同傳輸類（例如：LogTransport、SparkPostTransport 等）。

Swift_Mailer 類需要一個 Swift_Transport 實例，我們可以通過擴(kuò)展 IlluminateMailTransportTransport 類來滿足它。它應(yīng)該看起來像這樣。

php artisan make:provider DBMailProvider

我們應(yīng)該在這裡實現(xiàn)的唯一方法是 send 方法。它負(fù)責(zé)郵件發(fā)送邏輯，在這種情況下，它應(yīng)該將我們的電子郵件記錄到數(shù)據(jù)庫中。至於我們的構(gòu)造函數(shù)，我們目前可以將其留空，因為我們不需要任何外部依賴項。

$message->getTo() 方法始終返回收件人電子郵件和名稱的關(guān)聯(lián)數(shù)組。我們使用 array_keys 函數(shù)獲取電子郵件列表，然後將它們合併以獲取字符串。

將電子郵件記錄到數(shù)據(jù)庫

下一步是為我們的數(shù)據(jù)庫表創(chuàng)建必要的遷移。

// vendor/Illuminate/Mail/MailServiceProvider.php

public function register()
{
    $this->registerSwiftMailer();

    // ...
}

// app/Providers/DBMailProvider.php

function registerSwiftMailer()
{
    if ($this->app['config']['mail.driver'] == 'db') {
        $this->registerDBSwiftMailer();
    } else {
        parent::registerSwiftMailer();
    }
}

我們的遷移只包含電子郵件正文、主題和收件人電子郵件，但您可以根據(jù)需要添加更多詳細(xì)信息。檢查 Swift_Mime_Message 類定義以查看可用字段的列表。

現(xiàn)在，我們需要創(chuàng)建一個新的模型來與我們的表交互，並將必要的字段添加到 fillable 數(shù)組中。

Mail::send('emails.welcome', ['user' => $user], function ($m) use ($user) {
    $m->to($user->email, $user->name)->subject('Welcome to the website');
});

# 生成一個新的可郵件類
php artisan make:mail WelcomeMail

發(fā)送電子郵件

好的，現(xiàn)在是時候測試我們到目前為止所取得的成果了。我們首先將我們的提供程序添加到 config/app.php 文件中的提供程序列表中。

// app/Mail/WelcomeMail.php

class WelcomeUser extends Mailable
{
    use Queueable, SerializesModels;

    public $user;

    public function __construct(User $user)
    {
        $this->user = $user;
    }

    public function build()
    {
        return $this->view('emails.welcome');
    }
}

然後我們將郵件驅(qū)動程序註冊到 config/mail.php 文件中的 db 中。

// routes/web.php

Route::get('/', function () {
    $user = User::find(2);

    \Mail::to($user->email)->send(new WelcomeUser($user));

    return "done";
});

唯一剩下的部分是發(fā)送測試電子郵件並檢查它是否被記錄到數(shù)據(jù)庫中。我將在訪問主頁 URL 時發(fā)送電子郵件。以下是代碼。

php artisan make:provider DBMailProvider

訪問主頁路由後，我們可以運(yùn)行 php artisan tinker 命令來檢查 emails 表記錄。

結(jié)論

在本文中，我們看到瞭如何擴(kuò)展郵件驅(qū)動程序系統(tǒng)以攔截電子郵件以進(jìn)行調(diào)試。我在 Laravel 中欣賞的一件事是其無與倫比的可擴(kuò)展性：您可以更改或擴(kuò)展從路由器和 IOC 到郵件及其他幾乎所有功能。

如果您有任何問題或意見，請務(wù)必在下面發(fā)表，我會盡力回答！

關(guān)於 Laravel 5.3 中郵件日誌記錄的常見問題解答 (FAQ)

如何擴(kuò)展 Laravel 5.3 中的郵件驅(qū)動程序？

擴(kuò)展 Laravel 5.3 中的郵件驅(qū)動程序涉及創(chuàng)建新的服務(wù)提供程序。此服務(wù)提供程序?qū)U(kuò)展現(xiàn)有的郵件驅(qū)動程序，並允許您添加其他功能。您可以使用 php artisan make:provider 命令創(chuàng)建新的服務(wù)提供程序。創(chuàng)建提供程序後，您可以將其註冊到 config/app.php 文件中。在提供程序中，您可以使用 extend 方法將自定義功能添加到郵件驅(qū)動程序。

Laravel 中郵件日誌記錄的目的是什麼？

Laravel 中的郵件日誌記錄是一個允許您跟蹤應(yīng)用程序發(fā)送的所有傳出電子郵件的功能。這對於調(diào)試非常有用，因為它允許您準(zhǔn)確查看正在發(fā)送哪些電子郵件、何時發(fā)送以及發(fā)送給誰。它也對審計非常有用，因為它提供了應(yīng)用程序發(fā)送的所有電子郵件通信的記錄。

如何配置 Laravel 以記錄所有傳出電子郵件？

要配置 Laravel 以記錄所有傳出電子郵件，您需要修改 config/mail.php 文件。在此文件中，您可以將 log 選項設(shè)置為 true。這將指示 Laravel 記錄所有傳出電子郵件。日誌將存儲在 storage/logs 目錄中。

如何查看 Laravel 中的郵件日誌？

Laravel 中的郵件日誌存儲在 storage/logs 目錄中。您可以通過導(dǎo)航到此目錄並打開日誌文件來查看這些日誌。日誌文件根據(jù)日期命名，因此您可以輕鬆找到特定日期的日誌。

我可以自定義 Laravel 中郵件日誌的格式嗎？

是的，您可以自定義 Laravel 中郵件日誌的格式。這可以通過擴(kuò)展郵件驅(qū)動程序並覆蓋 log 方法來完成。在此方法中，您可以指定日誌消息的格式。

(其餘FAQ與郵件發(fā)送本身相關(guān)，與本例的郵件日誌擴(kuò)展無關(guān)，故省略)

請注意，圖片路徑 /uploads/20250210/173915090467a9563807841.webp 和 /uploads/20250210/173915090467a9563839bfc.webp 以及 /uploads/20250210/173915090667a9563a27b41.jpg 需要替換為實際可訪問的圖片鏈接。

以上是Laravel 5.3中的郵件記錄：擴(kuò)展郵件驅(qū)動程序的詳細(xì)內(nèi)容。更多資訊請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！