通知

簡介
生成通知
發送通知
郵件通知
Markdown 郵件通知
資料庫通知
廣播通知
簡訊通知
Slack 通知
本地化通知
測試
通知事件
自訂通道

簡介

除了支援發送郵件外，Laravel 還支援通過各種傳遞渠道發送通知，包括郵件、簡訊（通過 Vonage，以前稱為 Nexmo）和 Slack。此外，還創建了各種社區構建的通知渠道，可通過數十種不同的渠道發送通知！通知也可以存儲在數據庫中，以便在您的 Web 介面中顯示。

通常，通知應該是簡短的信息性消息，通知用戶應用程序中發生的事情。例如，如果您正在編寫一個計費應用程序，您可以通過電子郵件和簡訊渠道向用戶發送“發票已支付”通知。

生成通知

在 Laravel 中，每個通知都由一個單獨的類表示，通常存儲在 app/Notifications 目錄中。如果您在應用程序中找不到此目錄，不用擔心 - 當您運行 make:notification Artisan 命令時，它將為您創建：

php artisan make:notification InvoicePaid

此命令將在您的 app/Notifications 目錄中放置一個新的通知類。每個通知類都包含一個 via 方法和一個可變數量的消息構建方法，例如 toMail 或 toDatabase，將通知轉換為針對特定渠道定制的消息。

發送通知

使用 Notifiable Trait

通知可以通過 Notifiable trait 的 notify 方法或使用 Notification facade 兩種方式發送。Notifiable trait 默認包含在您應用程序的 App\Models\User 模型中：

<?php

namespace App\Models;

```php
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;
}

這個特性提供的 notify 方法預期接收一個通知實例：

use App\Notifications\InvoicePaid;

$user->notify(new InvoicePaid($invoice));

Note

請記住，您可以在任何模型上使用 Notifiable 特性。您不僅限於將其包含在您的 User 模型中。

使用通知 Facade

或者，您可以通過 Notification facade 發送通知。當您需要向多個可通知實體（例如一組用戶）發送通知時，這種方法很有用。要使用 facade 發送通知，請將所有可通知實體和通知實例傳遞給 send 方法：

use Illuminate\Support\Facades\Notification;

Notification::send($users, new InvoicePaid($invoice));

您還可以使用 sendNow 方法立即發送通知。即使通知實現了 ShouldQueue 接口，此方法也會立即發送通知：

Notification::sendNow($developers, new DeploymentCompleted($deployment));

指定傳遞通道

每個通知類都有一個 via 方法，該方法確定通知將傳遞到哪些通道。通知可以發送到 mail、database、broadcast、vonage 和 slack 通道。

Note

如果您想使用其他傳遞通道，如 Telegram 或 Pusher，請查看社區驅動的 Laravel 通知通道網站。

via 方法接收一個 $notifiable 實例，該實例將是發送通知的類別的實例。您可以使用 $notifiable 來確定通知應該在哪些通道上傳遞：

/**
 * 獲取通知的傳遞通道。
 *
 * @return array<int, string>
 */
public function via(object $notifiable): array
{
    return $notifiable->prefers_sms ? ['vonage'] : ['mail', 'database'];
}

通知佇列

Warning

在將通知加入佇列之前，您應該配置您的佇列並啟動一個工作程序。

發送通知可能需要一些時間，特別是如果通道需要進行外部 API 調用以傳遞通知。為了加快應用程式的響應時間，讓您的通知進入佇列，只需將 ShouldQueue 介面和 Queueable 特性添加到您的類別中。這些介面和特性已經被導入到使用 make:notification 命令生成的所有通知中，因此您可以立即將它們添加到您的通知類別中：

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue
{
    use Queueable;

    // ...
}

一旦將 ShouldQueue 介面添加到您的通知中，您可以像平常一樣發送通知。Laravel 將檢測到類別中的 ShouldQueue 介面，並自動將通知的傳遞加入佇列：

$user->notify(new InvoicePaid($invoice));

在將通知加入佇列時，將為每個接收者和通道組合創建一個佇列作業。例如，如果您的通知有三個接收者和兩個通道，將會向佇列派發六個作業。

延遲通知

如果您想要延遲通知的傳遞，您可以在通知實例上鏈接 delay 方法：

$delay = now()->addMinutes(10);

$user->notify((new InvoicePaid($invoice))->delay($delay));

您可以將一個陣列傳遞給 delay 方法，以指定特定通道的延遲時間：

$user->notify((new InvoicePaid($invoice))->delay([
    'mail' => now()->addMinutes(5),
    'sms' => now()->addMinutes(10),
]));

或者，您可以在通知類別本身定義一個 withDelay 方法。withDelay 方法應該返回一個通道名稱和延遲值的陣列：

/**
 * 確定通知的傳遞延遲。
 *
 * @return array<string, \Illuminate\Support\Carbon>
 */
public function withDelay(object $notifiable): array
{
    return [
        'mail' => now()->addMinutes(5),
        'sms' => now()->addMinutes(10),
    ];
}

自訂通知佇列連線

預設情況下，排入佇列的通知將使用應用程式的預設佇列連線。如果您想要為特定通知指定不同的連線，您可以在通知的建構子中呼叫 onConnection 方法：

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue
{
    use Queueable;

    /**
     * 建立新的通知實例。
     */
    public function __construct()
    {
        $this->onConnection('redis');
    }
}

或者，如果您想要為通知支援的每個通知渠道指定特定的佇列連線，您可以在通知中定義一個 viaConnections 方法。此方法應該返回一個通道名稱 / 佇列連線名稱對的陣列：

/**
 * 確定每個通知渠道應該使用的連線。
 *
 * @return array<string, string>
 */
public function viaConnections(): array
{
    return [
        'mail' => 'redis',
        'database' => 'sync',
    ];
}

自訂通知渠道佇列

如果您想要為通知支援的每個通知渠道指定應使用的特定佇列，您可以在通知中定義一個 viaQueues 方法。此方法應該返回一個通道名稱 / 佇列名稱對的陣列：```

    /**
     * 確定每個通知通道應使用哪些佇列。
     *
     * @return array<string, string>
     */
    public function viaQueues(): array
    {
        return [
            'mail' => 'mail-queue',
            'slack' => 'slack-queue',
        ];
    }

<a name="queued-notification-middleware"></a>
#### 佇列通知中介層

佇列通知可以定義中介層，[就像佇列工作一樣](/docs/{{version}}/queues#job-middleware)。要開始，請在通知類別上定義一個 `middleware` 方法。`middleware` 方法將接收 `$notifiable` 和 `$channel` 變數，這允許您根據通知的目的地自定義返回的中介層：

    use Illuminate\Queue\Middleware\RateLimited;

    /**
     * 獲取通知工作應通過的中介層。
     *
     * @return array<int, object>
     */
    public function middleware(object $notifiable, string $channel)
    {
        return match ($channel) {
            'email' => [new RateLimited('postmark')],
            'slack' => [new RateLimited('slack')],
            default => [],
        };
    }

<a name="queued-notifications-and-database-transactions"></a>
#### 佇列通知和資料庫交易

當佇列通知在資料庫交易中派發時，它們可能在資料庫交易提交之前被佇列處理。當這種情況發生時，在資料庫中可能尚未反映您在資料庫交易期間對模型或資料庫記錄所做的任何更新。此外，在交易中創建的任何模型或資料庫記錄可能尚不存在於資料庫中。如果您的通知依賴於這些模型，當處理發送佇列通知的工作時，可能會發生意外錯誤。

如果您的佇列連線的 `after_commit` 組態選項設置為 `false`，您仍可以在發送通知時調用 `afterCommit` 方法，指示特定的佇列通知應在所有開放的資料庫交易提交後派發：

use App\Notifications\InvoicePaid;

$user->notify((new InvoicePaid($invoice))->afterCommit());

或者，您可以從通知的建構子中調用 `afterCommit` 方法：

```php
<?php

namespace App\Notifications;

use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification implements ShouldQueue
{
    use Queueable;

    /**
     * 創建新的通知實例。
     */
    public function __construct()
    {
        $this->afterCommit();
    }
}

Note

若要了解更多有關解決這些問題的資訊，請參閱有關佇列工作和資料庫交易的文件。

確定是否應發送佇列通知

在為背景處理的佇列調度了佇列通知後，通常會被佇列工作者接受並發送給其預期的接收者。

但是，如果您想在佇列工作者處理後最終確定是否應發送佇列通知，您可以在通知類別上定義 shouldSend 方法。如果此方法返回 false，則不會發送通知：

/**
 * 確定是否應發送通知。
 */
public function shouldSend(object $notifiable, string $channel): bool
{
    return $this->invoice->isPaid();
}

需要時通知

有時您可能需要向未存儲為應用程式“使用者”的某人發送通知。使用 Notification 門面的 route 方法，您可以在發送通知之前指定臨時通知路由信息：

use Illuminate\Broadcasting\Channel;
use Illuminate\Support\Facades\Notification;

Notification::route('mail', 'taylor@example.com')
    ->route('vonage', '5555555555')
    ->route('slack', '#slack-channel')
    ->route('broadcast', [new Channel('channel-name')])
    ->notify(new InvoicePaid($invoice));

如果您想在發送即時通知到 mail 路由時提供收件人的名稱，您可以提供一個包含電子郵件地址作為鍵和名稱作為陣列第一個元素值的陣列：

Notification::route('mail', [
    'barrett@example.com' => 'Barrett Blair',
])->notify(new InvoicePaid($invoice));

使用 routes 方法，您可以一次為多個通知渠道提供臨時路由信息：

Notification::routes([
    'mail' => ['barrett@example.com' => 'Barrett Blair'],
    'vonage' => '5555555555',
])->notify(new InvoicePaid($invoice));

電子郵件通知

格式化郵件訊息

如果通知支持以電子郵件形式發送，您應該在通知類別上定義一個 toMail 方法。此方法將接收一個 $notifiable 實體，並應返回一個 Illuminate\Notifications\Messages\MailMessage 實例。

MailMessage 類別包含一些簡單的方法，可幫助您構建交易郵件訊息。郵件訊息可以包含文本行以及一個「呼籲動作」。讓我們看一個 toMail 方法的範例：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    $url = url('/invoice/'.$this->invoice->id);

    return (new MailMessage)
        ->greeting('您好！')
        ->line('您的一張發票已經支付！')
        ->lineIf($this->amount > 0, "支付金額：{$this->amount}")
        ->action('查看發票', $url)
        ->line('感謝您使用我們的應用！');
}

Note

請注意我們在 toMail 方法中使用了 $this->invoice->id。您可以將通知需要的任何數據傳遞到通知的構造函數中，以生成其訊息。

在此範例中，我們註冊了一個問候語、一行文本、一個呼籲動作，然後是另一行文本。MailMessage 物件提供的這些方法使得格式化小型交易郵件變得簡單快速。郵件通道將把這些訊息組件轉換為美觀、響應式的 HTML 電子郵件模板，同時還有純文本對應。這是 mail 通道生成的電子郵件範例：

Note

當發送郵件通知時，請務必在您的 config/app.php 配置文件中設置 name 配置選項。此值將用於郵件通知消息的標頭和頁腳。

錯誤訊息

有些通知會通知使用者發生錯誤，例如發票付款失敗。您可以在構建消息時調用 error 方法來指示郵件消息涉及錯誤。當在郵件消息上使用 error 方法時，操作按鈕將是紅色而不是黑色：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->error()
        ->subject('發票付款失敗')
        ->line('...');
}

其他郵件通知格式選項

您可以使用 view 方法來指定應用於呈現通知郵件的自定義模板，而不是在通知類中定義文本的“行”：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)->view(
        'mail.invoice.paid', ['invoice' => $this->invoice]
    );
}

您可以通過將視圖名稱作為傳遞給 view 方法的陣列的第二個元素來為郵件消息指定純文本視圖：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)->view(
        ['mail.invoice.paid', 'mail.invoice.paid-text'],
        ['invoice' => $this->invoice]
    );
}

或者，如果您的消息只有一個純文本視圖，您可以使用 text 方法：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)->text(
        'mail.invoice.paid-text', ['invoice' => $this->invoice]
    );
}

自訂寄件者

預設情況下，電子郵件的寄件者/寄件地址在 config/mail.php 設定檔中定義。但是，您可以使用 from 方法為特定通知指定寄件地址：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->from('barrett@example.com', 'Barrett Blair')
        ->line('...');
}

自訂收件者

當通過 mail 通道發送通知時，通知系統將自動查找您的可通知實體上的 email 屬性。您可以通過在可通知實體上定義 routeNotificationForMail 方法來自訂用於傳遞通知的電子郵件地址：

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 適用於郵件通道的通知路由。
     *
     * @return  array<string, string>|string
     */
    public function routeNotificationForMail(Notification $notification): array|string
    {
        // 僅返回電子郵件地址...
        return $this->email_address;

        // 返回電子郵件地址和名稱...
        return [$this->email_address => $this->name];
    }
}

自訂主旨

預設情況下，電子郵件的主旨是通知類別的類名格式化為「標題大小寫」。因此，如果您的通知類別名稱為 InvoicePaid，則電子郵件的主旨將是 Invoice Paid。如果您想為訊息指定不同的主旨，您可以在建立訊息時調用 subject 方法：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->subject('通知主旨')
        ->line('...');
}

自訂 Mailer

預設情況下，電子郵件通知將使用在 config/mail.php 組態檔中定義的預設 Mailer 進行發送。但是，您可以在運行時通過調用 mailer 方法來指定不同的 Mailer 來構建您的訊息：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->mailer('postmark')
        ->line('...');
}

自訂範本

您可以通過發佈通知套件的資源來修改郵件通知使用的 HTML 和純文字範本。執行此命令後，郵件通知範本將位於 resources/views/vendor/notifications 目錄中：

php artisan vendor:publish --tag=laravel-notifications

附件

要將附件添加到電子郵件通知中，請在構建訊息時使用 attach 方法。attach 方法將接受文件的絕對路徑作為其第一個引數：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attach('/path/to/file');
}

Note

通知郵件訊息提供的 attach 方法還接受可附加物件。請參考全面的可附加物件文件以瞭解更多。

當將文件附加到訊息時，您還可以通過將 array 作為 attach 方法的第二個引數來指定顯示名稱和/或 MIME 類型：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attach('/path/to/file', [
            'as' => 'name.pdf',
            'mime' => 'application/pdf',
        ]);
}

與在郵件對象中附加文件不同，您不能直接使用 attachFromStorage 從存儲磁盤附加文件。您應該改用帶有存儲磁盤上文件的絕對路徑的 attach 方法。或者，您可以從 toMail 方法返回一個郵件對象：

use App\Mail\InvoicePaid as InvoicePaidMailable;

/**
 * 獲取通知的郵件表示形式。
 */
public function toMail(object $notifiable): Mailable
{
    return (new InvoicePaidMailable($this->invoice))
        ->to($notifiable->email)
        ->attachFromStorage('/path/to/file');
}

在必要時，可以使用 attachMany 方法將多個文件附加到一條消息：

/**
 * 獲取通知的郵件表示形式。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attachMany([
            '/path/to/forge.svg',
            '/path/to/vapor.svg' => [
                'as' => 'Logo.svg',
                'mime' => 'image/svg+xml',
            ],
        ]);
}

附加原始數據

attachData 方法可用於將原始字節字符串作為附件附加。調用 attachData 方法時，應提供應分配給附件的文件名：

/**
 * 獲取通知的郵件表示形式。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('Hello!')
        ->attachData($this->pdf, 'name.pdf', [
            'mime' => 'application/pdf',
        ]);
}

添加標籤和元數據

一些第三方郵件提供商，如 Mailgun 和 Postmark，支持消息“標籤”和“元數據”，可用於分組和跟踪應用程序發送的郵件。您可以通過 tag 和 metadata 方法向電子郵件消息添加標籤和元數據：

/**
 * 獲取通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->greeting('評論已點贊！')
        ->tag('upvote')
        ->metadata('comment_id', $this->comment->id);
}

如果您的應用程式使用Mailgun驅動程式，您可以查閱Mailgun的文件以獲取有關標籤和元數據的更多信息。同樣地，您也可以查閱Postmark文件以獲取有關其對標籤和元數據支援的更多信息。

如果您的應用程式使用Amazon SES發送郵件，您應該使用metadata方法將SES“標籤”附加到消息中。

自定義Symfony消息

MailMessage類的withSymfonyMessage方法允許您註冊一個閉包，在發送消息之前將使用Symfony消息實例調用該閉包。這為您提供了在消息傳遞之前深度自定義消息的機會：

use Symfony\Component\Mime\Email;

/**
 * 獲取通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    return (new MailMessage)
        ->withSymfonyMessage(function (Email $message) {
            $message->getHeaders()->addTextHeader(
                'Custom-Header', 'Header Value'
            );
        });
}

使用Mailables

如果需要，您可以從通知的toMail方法返回完整的mailable對象。當返回Mailable而不是MailMessage時，您需要使用mailable對象的to方法指定消息接收者：


<a name="mailables-and-on-demand-notifications"></a>
#### Mailables and On-Demand Notifications

如果您正在發送[即時通知](#on-demand-notifications)，則傳遞給`toMail`方法的`$notifiable`實例將是`Illuminate\Notifications\AnonymousNotifiable`的實例，該實例提供了一個`routeNotificationFor`方法，可用於檢索應發送即時通知的電子郵件地址：

```php
use App\Mail\InvoicePaid as InvoicePaidMailable;
use Illuminate\Notifications\AnonymousNotifiable;
use Illuminate\Mail\Mailable;

/**
 * 獲取通知的郵件表示。
 */
public function toMail(object $notifiable): Mailable
{
    $address = $notifiable instanceof AnonymousNotifiable
        ? $notifiable->routeNotificationFor('mail')
        : $notifiable->email;

    return (new InvoicePaidMailable($this->invoice))
        ->to($address);
}

預覽郵件通知

在設計郵件通知模板時，快速在瀏覽器中預覽渲染的郵件消息就像典型的 Blade 模板一樣很方便。因此，Laravel 允許您直接從路由閉包或控制器返回由郵件通知生成的任何郵件消息。當返回MailMessage時，它將被渲染並顯示在瀏覽器中，讓您可以快速預覽其設計，而無需將其發送到實際的電子郵件地址：

use App\Models\Invoice;
use App\Notifications\InvoicePaid;

Route::get('/notification', function () {
    $invoice = Invoice::find(1);

    return (new InvoicePaid($invoice))
        ->toMail($invoice->user);
});

Markdown 郵件通知

Markdown 郵件通知允許您利用郵件通知的預建範本，同時讓您更自由地撰寫更長、自定義的訊息。由於這些訊息是用 Markdown 撰寫的，Laravel 能夠為這些訊息渲染出美觀、響應式的 HTML 模板，同時也自動生成一個純文字的對應版本。

生成訊息

要生成一個帶有對應 Markdown 模板的通知，您可以使用 make:notification Artisan 指令的 --markdown 選項：

php artisan make:notification InvoicePaid --markdown=mail.invoice.paid

與所有其他郵件通知一樣，使用 Markdown 模板的通知應在其通知類別上定義一個 toMail 方法。但是，不同於使用 line 和 action 方法來構建通知，請使用 markdown 方法來指定應使用的 Markdown 模板的名稱。您希望傳遞給模板的數據陣列可以作為該方法的第二個引數傳遞：

/**
 * 取得通知的郵件表示。
 */
public function toMail(object $notifiable): MailMessage
{
    $url = url('/invoice/'.$this->invoice->id);

    return (new MailMessage)
        ->subject('Invoice Paid')
        ->markdown('mail.invoice.paid', ['url' => $url]);
}

撰寫訊息

Markdown 郵件通知使用 Blade 元件和 Markdown 語法的組合，讓您可以輕鬆構建通知，同時利用 Laravel 預先製作的通知元件：

<x-mail::message>
# Invoice Paid

Your invoice has been paid!

<x-mail::button :url="$url">
View Invoice
</x-mail::button>

Thanks,<br>
{{ config('app.name') }}
</x-mail::message>

按鈕元件

按鈕元件呈現一個置中的按鈕連結。該元件接受兩個引數，一個是 url，另一個是可選的 color。支援的顏色有 primary、green 和 red。您可以將任意數量的按鈕元件添加到通知中。

<x-mail::button :url="$url" color="green">
查看發票
</x-mail::button>

面板元件

面板元件將指定的文本區塊呈現在具有與通知其餘部分略有不同背景顏色的面板中。這使您可以將注意力集中在特定的文本區塊上：

<x-mail::panel>
這是面板內容。
</x-mail::panel>

表格元件

表格元件允許您將 Markdown 表格轉換為 HTML 表格。該元件將接受 Markdown 表格作為其內容。表格列對齊支持使用默認的 Markdown 表格對齊語法：

<x-mail::table>
| Laravel       | Table         | Example       |
| ------------- | :-----------: | ------------: |
| Col 2 is      | Centered      | $10           |
| Col 3 is      | Right-Aligned | $20           |
</x-mail::table>

自定義元件

您可以將所有的 Markdown 通知元件導出到您自己的應用程序進行自定義。要導出這些元件，請使用 vendor:publish Artisan 命令來發布 laravel-mail 資源標籤：

php artisan vendor:publish --tag=laravel-mail

此命令將將 Markdown 郵件元件發布到 resources/views/vendor/mail 目錄中。mail 目錄將包含一個 html 和一個 text 目錄，每個目錄都包含每個可用元件的相應表示。您可以自由地自定義這些元件。

自定義 CSS

在導出元件之後，resources/views/vendor/mail/html/themes 目錄將包含一個 default.css 文件。您可以在此文件中自定義 CSS，您的樣式將自動內嵌在 Markdown 通知的 HTML 表示中。

如果您想為 Laravel 的 Markdown 元件構建全新主題，您可以將一個 CSS 文件放在 html/themes 目錄中。命名並保存您的 CSS 文件後，請更新 mail 配置文件的 theme 選項以匹配您的新主題的名稱。

要為單個通知自定義主題，您可以在構建通知郵件消息時調用 theme 方法。theme 方法接受應在發送通知時使用的主題名稱：

    /**
     * 取得通知的郵件表示。
     */
    public function toMail(object $notifiable): MailMessage
    {
        return (new MailMessage)
            ->theme('invoice')
            ->subject('Invoice Paid')
            ->markdown('mail.invoice.paid', ['url' => $url]);
    }

資料庫通知

先決條件

database 通知通道將通知資訊存儲在資料庫表中。此表將包含通知類型以及描述通知的 JSON 數據結構等信息。

您可以查詢該表以在應用程式的使用者界面中顯示通知。但在此之前，您需要創建一個資料庫表來保存您的通知。您可以使用 make:notifications-table 命令生成具有正確表結構的遷移：

php artisan make:notifications-table

php artisan migrate

Note

如果您的可通知模型使用 UUID 或 ULID 主鍵，您應該在通知表遷移中將 morphs 方法替換為 uuidMorphs 或 ulidMorphs。

格式化資料庫通知

如果通知支持存儲在資料庫表中，您應該在通知類別上定義 toDatabase 或 toArray 方法。此方法將接收一個 $notifiable 實體並應返回一個普通的 PHP 陣列。返回的陣列將被編碼為 JSON 並存儲在您的 notifications 表的 data 列中。讓我們看一個 toArray 方法的示例：

/**
 * 取得通知的陣列表示。
 *
 * @return array<string, mixed>
 */
public function toArray(object $notifiable): array
{
    return [
        'invoice_id' => $this->invoice->id,
        'amount' => $this->invoice->amount,
    ];
}


當通知存儲在應用程式的資料庫中時，`type` 欄位將默認設置為通知的類別名稱，而 `read_at` 欄位將為 `null`。但是，您可以通過在通知類別中定義 `databaseType` 和 `initialDatabaseReadAtValue` 方法來自定義此行為：

```php
use Illuminate\Support\Carbon;

/**
 * 獲取通知的資料庫類型。
 */
public function databaseType(object $notifiable): string
{
    return 'invoice-paid';
}

/**
 * 獲取“read_at”欄位的初始值。
 */
public function initialDatabaseReadAtValue(): ?Carbon
{
    return null;
}

`toDatabase` vs. `toArray`

toArray 方法也被 broadcast 頻道使用，以確定要廣播到您的 JavaScript 前端的數據。如果您希望為 database 和 broadcast 頻道定義兩種不同的數組表示形式，則應定義 toDatabase 方法而不是 toArray 方法。

存取通知

一旦通知存儲在資料庫中，您需要一種方便的方式從您的可通知實體中訪問它們。Illuminate\Notifications\Notifiable 特性包含在 Laravel 默認的 App\Models\User 模型上，其中包括一個 notifications Eloquent 關聯，該關聯返回實體的通知。要獲取通知，您可以像訪問任何其他 Eloquent 關聯一樣訪問此方法。默認情況下，通知將按照 created_at 時間戳進行排序，最近的通知將出現在集合的開頭：

$user = App\Models\User::find(1);

foreach ($user->notifications as $notification) {
    echo $notification->type;
}

如果您只想檢索“未讀”通知，則可以使用 unreadNotifications 關聯。同樣，這些通知將按照 created_at 時間戳進行排序，最近的通知將出現在集合的開頭：

$user = App\Models\User::find(1);

foreach ($user->unreadNotifications as $notification) {
    echo $notification->type;
}

Note

要從您的JavaScript客戶端訪問通知，您應該為應用程序定義一個通知控制器，該控制器返回可通知實體（例如當前用戶）的通知。然後，您可以從JavaScript客戶端對該控制器的URL進行HTTP請求。

標記通知為已讀

通常，當用戶查看通知時，您會希望將通知標記為“已讀”。Illuminate\Notifications\Notifiable特徵提供了一個markAsRead方法，該方法會更新通知的數據庫記錄上的read_at列：

$user = App\Models\User::find(1);

foreach ($user->unreadNotifications as $notification) {
    $notification->markAsRead();
}

但是，您可以直接在通知集合上使用markAsRead方法，而不是遍歷每個通知：

$user->unreadNotifications->markAsRead();

您還可以使用大量更新查詢將所有通知標記為已讀，而無需從數據庫檢索它們：

$user = App\Models\User::find(1);

$user->unreadNotifications()->update(['read_at' => now()]);

您可以使用delete方法從表中完全刪除通知：

$user->notifications()->delete();

廣播通知

先決條件

在廣播通知之前，您應該配置並熟悉Laravel的事件廣播服務。事件廣播提供了一種從JavaScript驅動的前端對服務器端Laravel事件做出反應的方式。

格式化廣播通知

broadcast通道使用Laravel的事件廣播服務廣播通知，從而使您的JavaScript驅動的前端能夠實時捕獲通知。如果通知支持廣播，則可以在通知類上定義一個toBroadcast方法。此方法將接收一個$notifiable實體，並應返回一個BroadcastMessage實例。如果toBroadcast方法不存在，則將使用toArray方法來收集應該廣播的數據。返回的數據將被編碼為JSON並廣播到您的JavaScript驅動的前端。讓我們看一個toBroadcast方法的示例：


```php
use Illuminate\Notifications\Messages\BroadcastMessage;

/**
 * 取得通知的廣播表示。
 */
public function toBroadcast(object $notifiable): BroadcastMessage
{
    return new BroadcastMessage([
        'invoice_id' => $this->invoice->id,
        'amount' => $this->invoice->amount,
    ]);
}

廣播佇列配置

所有廣播通知都會排入佇列進行廣播。如果您想要配置用於排入廣播操作的佇列連線或佇列名稱，您可以使用 BroadcastMessage 的 onConnection 和 onQueue 方法：

return (new BroadcastMessage($data))
    ->onConnection('sqs')
    ->onQueue('broadcasts');

自訂通知類型

除了您指定的資料外，所有廣播通知還包含一個包含通知完整類別名稱的 type 欄位。如果您想要自訂通知的 type，您可以在通知類別上定義一個 broadcastType 方法：

/**
 * 取得正在廣播的通知類型。
 */
public function broadcastType(): string
{
    return 'broadcast.message';
}

監聽通知

通知將以 {notifiable}.{id} 慣例格式化的私人頻道進行廣播。因此，如果您向具有 ID 為 1 的 App\Models\User 實例發送通知，該通知將在 App.Models.User.1 私人頻道上廣播。當使用 Laravel Echo 時，您可以輕鬆使用 notification 方法在頻道上監聽通知：

Echo.private('App.Models.User.' + userId)
    .notification((notification) => {
        console.log(notification.type);
    });

自訂通知頻道


如果您想要自訂實體的廣播通知要廣播到哪個頻道，您可以在可通知的實體上定義一個 `receivesBroadcastNotificationsOn` 方法：

```php
<?php

namespace App\Models;

use Illuminate\Broadcasting\PrivateChannel;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 使用者接收通知廣播的頻道。
     */
    public function receivesBroadcastNotificationsOn(): string
    {
        return 'users.'.$this->id;
    }
}

簡訊通知

先決條件

在 Laravel 中發送簡訊通知是由 Vonage（前身為 Nexmo）提供支援。在您可以透過 Vonage 發送通知之前，您需要安裝 laravel/vonage-notification-channel 和 guzzlehttp/guzzle 套件：

composer require laravel/vonage-notification-channel guzzlehttp/guzzle

該套件包含一個組態檔。但是，您不需要將此組態檔匯出到您自己的應用程式。您可以簡單地使用 VONAGE_KEY 和 VONAGE_SECRET 環境變數來定義您的 Vonage 公鑰和私鑰。

在定義您的金鑰之後，您應該設定一個 VONAGE_SMS_FROM 環境變數，該變數定義了默認情況下應該從哪個電話號碼發送您的簡訊訊息。您可以在 Vonage 控制面板中生成此電話號碼：

VONAGE_SMS_FROM=15556666666

格式化簡訊通知

如果通知支援作為簡訊發送，您應該在通知類別上定義一個 toVonage 方法。此方法將接收一個 $notifiable 實體，並應該返回一個 Illuminate\Notifications\Messages\VonageMessage 實例：

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 獲取通知的 Vonage / SMS 表示。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->content('您的簡訊內容');
}

Unicode Content

如果您的簡訊內容包含 Unicode 字元，您應該在建構 VonageMessage 實例時調用 unicode 方法：

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 獲取通知的 Vonage / SMS 表示。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->content('您的 Unicode 訊息')
        ->unicode();
}

自訂「寄件者」號碼

如果您想要從與您的 VONAGE_SMS_FROM 環境變數指定的電話號碼不同的電話號碼發送一些通知，您可以在 VonageMessage 實例上調用 from 方法：

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 獲取通知的 Vonage / SMS 表示。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->content('您的簡訊內容')
        ->from('15554443333');
}

添加客戶參考

如果您想要跟蹤每位使用者、團隊或客戶的成本，您可以將「客戶參考」添加到通知中。 Vonage 將允許您使用此客戶參考生成報告，以便更好地了解特定客戶的簡訊使用情況。客戶參考可以是長達 40 個字符的任何字符串：

use Illuminate\Notifications\Messages\VonageMessage;

/**
 * 獲取通知的 Vonage / SMS 表示。
 */
public function toVonage(object $notifiable): VonageMessage
{
    return (new VonageMessage)
        ->clientReference((string) $notifiable->id)
        ->content('您的簡訊內容');
}

路由簡訊通知

要將 Vonage 通知路由到正確的電話號碼，請在您的可通知實體上定義一個 routeNotificationForVonage 方法：

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * Route notifications for the Vonage channel.
     */
    public function routeNotificationForVonage(Notification $notification): string
    {
        return $this->phone_number;
    }
}

Slack 通知

先決條件

在發送 Slack 通知之前，您應該透過 Composer 安裝 Slack 通知頻道：

composer require laravel/slack-notification-channel

此外，您必須為您的 Slack 工作區建立一個 Slack 應用程式。

如果您只需要將通知發送到創建應用程式的相同 Slack 工作區，請確保您的應用程式具有 chat:write、chat:write.public 和 chat:write.customize 範圍。如果您想要以您的 Slack 應用程式身分發送訊息，請確保您的應用程式還具有 chat:write:bot 範圍。這些範圍可以從 Slack 內的「OAuth & Permissions」應用程式管理選項卡中添加。

接下來，複製應用程式的「Bot User OAuth Token」並將其放置在應用程式的 services.php 配置檔案中的 slack 配置陣列中。此 Token 可在 Slack 內的「OAuth & Permissions」選項卡中找到：

'slack' => [
    'notifications' => [
        'bot_user_oauth_token' => env('SLACK_BOT_USER_OAUTH_TOKEN'),
        'channel' => env('SLACK_BOT_USER_DEFAULT_CHANNEL'),
    ],
],

應用程式分發

如果您的應用程式將向您應用程式使用者擁有的外部 Slack 工作區發送通知，您需要透過 Slack「分發」您的應用程式。您可以從 Slack 內的應用程式「管理分發」選項卡中管理應用程式的分發。一旦您的應用程式被分發，您可以使用 Socialite 代表您的應用程式使用者獲取 Slack Bot 權杖。

格式化 Slack 通知

如果通知支持作為 Slack 消息發送，您應該在通知類別上定義一個 toSlack 方法。此方法將接收一個 $notifiable 實體，並應返回一個 Illuminate\Notifications\Slack\SlackMessage 實例。您可以使用 Slack 的 Block Kit API 構建豐富的通知。以下示例可以在 Slack 的 Block Kit builder:

use Illuminate\Notifications\Slack\BlockKit\Blocks\ContextBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock;
use Illuminate\Notifications\Slack\BlockKit\Composites\ConfirmObject;
use Illuminate\Notifications\Slack\SlackMessage;

/**
 * 獲取通知的 Slack 表示形式。
 */
public function toSlack(object $notifiable): SlackMessage
{
    return (new SlackMessage)
        ->text('您的發票之一已付款！')
        ->headerBlock('Invoice Paid')
        ->contextBlock(function (ContextBlock $block) {
            $block->text('客戶 #1234');
        })
        ->sectionBlock(function (SectionBlock $block) {
            $block->text('已支付一張發票。');
            $block->field("*Invoice No:*\n1000")->markdown();
            $block->field("*Invoice Recipient:*\ntaylor@laravel.com")->markdown();
        })
        ->dividerBlock()
        ->sectionBlock(function (SectionBlock $block) {
            $block->text('恭喜！');
        });
}

_{永久鏈接：https://laravel.com/docs/8.x/notifications#formatting-slack-notifications}

使用 Slack 的區塊套件生成器模板

不再使用流暢的訊息生成器方法來構建您的區塊套件訊息，您可以將由 Slack 的區塊套件生成器生成的原始 JSON 載荷提供給 usingBlockKitTemplate 方法：

use Illuminate\Notifications\Slack\SlackMessage;
use Illuminate\Support\Str;

/**
 * 獲取通知的 Slack 表示。
 */
public function toSlack(object $notifiable): SlackMessage
{
    $template = <<<JSON
        {
          "blocks": [
            {
              "type": "header",
              "text": {
                "type": "plain_text",
                "text": "團隊公告"
              }
            },
            {
              "type": "section",
              "text": {
                "type": "plain_text",
                "text": "我們正在招聘！"
              }
            }
          ]
        }
    JSON;

    return (new SlackMessage)
        ->usingBlockKitTemplate($template);
}

Slack 互動性

Slack 的區塊套件通知系統提供強大的功能來處理使用者互動。要使用這些功能，您的 Slack 應用程式應啟用「互動性」，並配置指向您的應用程式提供的 URL 的「請求 URL」。這些設置可以從 Slack 內的「互動性與快捷方式」應用程式管理選項卡中進行管理。

在以下示例中，使用 actionsBlock 方法，Slack 將向您的「請求 URL」發送一個包含點擊按鈕的 Slack 使用者、點擊按鈕的 ID 等內容的 POST 請求。然後，您的應用程式可以根據載荷決定要採取的操作。您還應驗證請求是否由 Slack 發出：

use Illuminate\Notifications\Slack\BlockKit\Blocks\ActionsBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\ContextBlock;
use Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock;
use Illuminate\Notifications\Slack\SlackMessage;

    /**
     * 獲取通知的 Slack 表示形式。
     */
    public function toSlack(object $notifiable): SlackMessage
    {
        return (new SlackMessage)
            ->text('您的發票之一已付款！')
            ->headerBlock('已支付發票')
            ->contextBlock(function (ContextBlock $block) {
                $block->text('客戶 #1234');
            })
            ->sectionBlock(function (SectionBlock $block) {
                $block->text('已支付發票。');
            })
            ->actionsBlock(function (ActionsBlock $block) {
                 // ID 預設為 "button_acknowledge_invoice"...
                $block->button('確認發票')->primary();

                // 手動配置 ID...
                $block->button('拒絕')->danger()->id('deny_invoice');
            });
    }

<a name="slack-confirmation-modals"></a>
#### 確認模式對話框

如果您希望用戶在執行操作之前需要確認，您可以在定義按鈕時調用 `confirm` 方法。`confirm` 方法接受一條消息和一個接收 `ConfirmObject` 實例的閉包：

    use Illuminate\Notifications\Slack\BlockKit\Blocks\ActionsBlock;
    use Illuminate\Notifications\Slack\BlockKit\Blocks\ContextBlock;
    use Illuminate\Notifications\Slack\BlockKit\Blocks\SectionBlock;
    use Illuminate\Notifications\Slack\BlockKit\Composites\ConfirmObject;
    use Illuminate\Notifications\Slack\SlackMessage;

    /**
     * 獲取通知的 Slack 表示形式。
     */
    public function toSlack(object $notifiable): SlackMessage
    {
        return (new SlackMessage)
            ->text('您的發票之一已付款！')
            ->headerBlock('已支付發票')
            ->contextBlock(function (ContextBlock $block) {
                $block->text('客戶 #1234');
            })
            ->sectionBlock(function (SectionBlock $block) {
                $block->text('已支付發票。');
            })
            ->actionsBlock(function (ActionsBlock $block) {
                $block->button('確認發票')
                    ->primary()
                    ->confirm(
                        '確認付款並發送感謝郵件？',
                        function (ConfirmObject $dialog) {
                            $dialog->confirm('是');
                            $dialog->deny('否');
                        }
                    );
            });
    }

檢查 Slack 區塊

如果您想快速檢查您正在建立的區塊，可以在 SlackMessage 實例上調用 dd 方法。dd 方法將生成並轉儲到 Slack 的 Block Kit Builder 的 URL，該工具會在瀏覽器中顯示有效載荷和通知的預覽。您可以將 true 傳遞給 dd 方法以轉儲原始有效載荷：

return (new SlackMessage)
        ->text('您的發票之一已經支付！')
        ->headerBlock('已支付發票')
        ->dd();

路由 Slack 通知

要將 Slack 通知定向到適當的 Slack 團隊和頻道，請在您的可通知模型上定義一個 routeNotificationForSlack 方法。此方法可以返回三個值之一：

null - 這將延遲路由到通知本身中配置的頻道。在構建您的 SlackMessage 時，您可以使用 to 方法來配置通知中的頻道。
指定要將通知發送到的 Slack 頻道的字符串，例如 #support-channel。
一個 SlackRoute 實例，允許您指定 OAuth 標記和頻道名稱，例如 SlackRoute::make($this->slack_channel, $this->slack_token)。應使用此方法將通知發送到外部工作區。

例如，從 routeNotificationForSlack 方法返回 #support-channel 將會將通知發送到與位於應用程式的 services.php 配置文件中的 Bot User OAuth 標記關聯的工作區中的 #support-channel 頻道：

<?php

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * 路由 Slack 頻道的通知。
     */
    public function routeNotificationForSlack(Notification $notification): mixed
    {
        return '#support-channel';
    }
}

通知外部 Slack 工作區

Note

在將通知發送至外部 Slack 工作區之前，您的 Slack 應用程式必須先進行分發。

當然，您通常會希望將通知發送至您應用程式使用者擁有的 Slack 工作區。為此，您首先需要為使用者取得一個 Slack OAuth 權杖。幸運的是，Laravel Socialite 包含了一個 Slack 驅動程式，讓您可以輕鬆地使用 Slack 驗證您應用程式的使用者並取得機器人權杖。

當您取得機器人權杖並將其存儲在您的應用程式資料庫中後，您可以使用 SlackRoute::make 方法將通知路由到使用者的工作區。此外，您的應用程式可能需要提供一個機會讓使用者指定應將通知發送至哪個頻道：

namespace App\Models;

use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Notifications\Notification;
use Illuminate\Notifications\Slack\SlackRoute;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * Route notifications for the Slack channel.
     */
    public function routeNotificationForSlack(Notification $notification): mixed
    {
        return SlackRoute::make($this->slack_channel, $this->slack_token);
    }
}

本地化通知

Laravel 允許您以不同於 HTTP 請求當前語言環境的語言環境發送通知，並且即使通知被排隊，系統也會記住此語言環境。

為了實現這一點，Illuminate\Notifications\Notification 類提供了一個 locale 方法來設置所需的語言。當評估通知時，應用程式將切換到此語言環境，並在評估完成後恢復到先前的語言環境：

$user->notify((new InvoicePaid($invoice))->locale('es'));

多個可通知項目的本地化也可以通過 Notification 門面實現：

Notification::locale('es')->send(
    $users, new InvoicePaid($invoice)
);

使用者偏好語言

有時，應用程式會儲存每個使用者的偏好語言。通過在您的可通知模型上實現 HasLocalePreference 合約，您可以指示 Laravel 在發送通知時使用此儲存的語言：

use Illuminate\Contracts\Translation\HasLocalePreference;

class User extends Model implements HasLocalePreference
{
    /**
     * 取得使用者的偏好語言。
     */
    public function preferredLocale(): string
    {
        return $this->locale;
    }
}

一旦您實現了該介面，Laravel 將在向模型發送通知和郵件時自動使用偏好語言。因此，在使用此介面時無需調用 locale 方法：

$user->notify(new InvoicePaid($invoice));

測試

您可以使用 Notification 門面的 fake 方法來防止發送通知。通常，發送通知與您實際測試的程式碼無關。很可能，僅需斷言 Laravel 已被指示發送特定通知即可。

在調用 Notification 門面的 fake 方法後，您可以斷言已被指示將通知發送給使用者，甚至檢查通知接收到的資料：

<?php

use App\Notifications\OrderShipped;
use Illuminate\Support\Facades\Notification;

test('orders can be shipped', function () {
    Notification::fake();

    // Perform order shipping...

    // Assert that no notifications were sent...
    Notification::assertNothingSent();

    // Assert a notification was sent to the given users...
    Notification::assertSentTo(
        [$user], OrderShipped::class
    );

    // Assert a notification was not sent...
    Notification::assertNotSentTo(
        [$user], AnotherNotification::class
    );

    // Assert that a given number of notifications were sent...
    Notification::assertCount(3);
});

<?php

namespace Tests\Feature;

use App\Notifications\OrderShipped;
use Illuminate\Support\Facades\Notification;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_orders_can_be_shipped(): void
    {
        Notification::fake();

        // Perform order shipping...

        // Assert that no notifications were sent...
        Notification::assertNothingSent();

        // Assert a notification was sent to the given users...
        Notification::assertSentTo(
            [$user], OrderShipped::class
        );

        // Assert a notification was not sent...
        Notification::assertNotSentTo(
            [$user], AnotherNotification::class
        );

        // Assert that a given number of notifications were sent...
        Notification::assertCount(3);
    }
}

您可以將閉包傳遞給 assertSentTo 或 assertNotSentTo 方法，以斷言已發送通知並通過給定的「真實測試」。如果至少發送了一條通知並通過了給定的真實測試，則斷言將成功：

Notification::assertSentTo(
    $user,
    function (OrderShipped $notification, array $channels) use ($order) {
        return $notification->order->id === $order->id;
    }
);

按需通知

如果您正在測試的程式碼發送了按需通知，您可以通過 assertSentOnDemand 方法來測試是否發送了按需通知：

Notification::assertSentOnDemand(OrderShipped::class);

通過將閉包作為 assertSentOnDemand 方法的第二個參數，您可以確定是否向正確的「路由」地址發送了按需通知：

Notification::assertSentOnDemand(
    OrderShipped::class,
    function (OrderShipped $notification, array $channels, object $notifiable) use ($user) {
        return $notifiable->routes['mail'] === $user->email;
    }
);

通知事件

通知發送事件

當通知正在發送時，通知系統會發送 Illuminate\Notifications\Events\NotificationSending 事件。這包含了「notifiable」實體和通知實例本身。您可以在應用程式中為此事件創建事件監聽器：

use Illuminate\Notifications\Events\NotificationSending;

class CheckNotificationStatus
{
    /**
     * 處理給定的事件。
     */
    public function handle(NotificationSending $event): void
    {
        // ...
    }
}

如果 NotificationSending 事件的事件監聽器從其 handle 方法返回 false，則通知將不會被發送：

/**
 * 處理給定的事件。
 */
public function handle(NotificationSending $event): bool
{
    return false;
}

在事件監聽器中，您可以訪問事件的 notifiable、notification 和 channel 屬性，以更多了解通知接收者或通知本身：

/**
 * 處理給定的事件。
 */
public function handle(NotificationSending $event): void
{
    // $event->channel
    // $event->notifiable
    // $event->notification
}

通知已發送事件

當發送通知時，通知系統會發送 Illuminate\Notifications\Events\NotificationSent 事件。此事件包含「notifiable」實體和通知實例本身。您可以在應用程式中為此事件建立事件監聽器：

use Illuminate\Notifications\Events\NotificationSent;

class LogNotification
{
    /**
     * 處理給定的事件。
     */
    public function handle(NotificationSent $event): void
    {
        // ...
    }
}

在事件監聽器中，您可以存取事件的 notifiable、notification、channel 和 response 屬性，以瞭解更多關於通知接收者或通知本身的資訊：

/**
 * 處理給定的事件。
 */
public function handle(NotificationSent $event): void
{
    // $event->channel
    // $event->notifiable
    // $event->notification
    // $event->response
}

自訂通道

Laravel 預設提供了一些通知通道，但您可能希望撰寫自己的驅動程式，以透過其他通道傳遞通知。Laravel 讓這變得簡單。要開始，定義一個包含 send 方法的類別。該方法應該接收兩個引數：$notifiable 和 $notification。

在 send 方法中，您可以呼叫通知的方法來檢索您的通道理解的訊息物件，然後以您希望的方式將通知發送給 $notifiable 實例：

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification;

class VoiceChannel
{
    /**
     * 發送給定的通知。
     */
    public function send(object $notifiable, Notification $notification): void
    {
        $message = $notification->toVoice($notifiable);

        // 將通知發送給 $notifiable 實例...
    }
}

一旦您定義了通知頻道類別，您可以從任何通知的 via 方法中返回類別名稱。在這個例子中，您的通知的 toVoice 方法可以返回您選擇來代表語音訊息的任何物件。例如，您可以定義自己的 VoiceMessage 類別來代表這些訊息：

<?php

namespace App\Notifications;

use App\Notifications\Messages\VoiceMessage;
use App\Notifications\VoiceChannel;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Notifications\Notification;

class InvoicePaid extends Notification
{
    use Queueable;

    /**
     * 取得通知頻道。
     */
    public function via(object $notifiable): string
    {
        return VoiceChannel::class;
    }

    /**
     * 取得通知的語音表示。
     */
    public function toVoice(object $notifiable): VoiceMessage
    {
        // ...
    }
}

Files

notifications.md

Latest commit

History

notifications.md

File metadata and controls

通知

簡介

生成通知

發送通知

使用 Notifiable Trait

使用通知 Facade

指定傳遞通道

通知佇列

延遲通知

自訂通知佇列連線

自訂通知渠道佇列

確定是否應發送佇列通知

需要時通知

電子郵件通知

格式化郵件訊息

錯誤訊息

其他郵件通知格式選項

自訂寄件者

自訂收件者

自訂主旨

自訂 Mailer

自訂範本

附件

附加原始數據

添加標籤和元數據

自定義Symfony消息

使用Mailables

預覽郵件通知

Markdown 郵件通知

生成訊息

撰寫訊息

按鈕元件

面板元件

表格元件

自定義元件

自定義 CSS

資料庫通知

先決條件

格式化資料庫通知

toDatabase vs. toArray

存取通知

標記通知為已讀

廣播通知

先決條件

格式化廣播通知

廣播佇列配置

自訂通知類型

監聽通知

自訂通知頻道

簡訊通知

先決條件

格式化簡訊通知

Unicode Content

自訂「寄件者」號碼

添加客戶參考

路由簡訊通知

Slack 通知

先決條件

應用程式分發

格式化 Slack 通知

使用 Slack 的區塊套件生成器模板

Slack 互動性

檢查 Slack 區塊

路由 Slack 通知

通知外部 Slack 工作區

本地化通知

使用者偏好語言

測試

按需通知

通知事件

通知發送事件

通知已發送事件

自訂通道

`toDatabase` vs. `toArray`