> ## Documentation Index
> Fetch the complete documentation index at: https://kawax.biz/llms.txt
> Use this file to discover all available pages before exploring further.
# メール送信
> LaravelのMailableクラスを使ったメール送信の基本から、Markdownメール・キュー送信まで解説します。
## Laravelのメール機能とは
Laravelのメール機能は [Symfony Mailer](https://symfony.com/doc/current/mailer.html) をベースに構築されており、SMTP・Mailgun・Postmark・Resend・Amazon SES・sendmailなどのドライバーに対応しています。
以前のLaravelで使われていたSwiftMailerは廃止されています。Laravel 9以降はSymfony Mailerを使います。
メール設定は `config/mail.php` で管理します。`.env` ファイルで使用するドライバーを切り替えることができます。
```ini theme={null}
MAIL_MAILER=smtp
MAIL_HOST=smtp.example.com
MAIL_PORT=587
MAIL_USERNAME=your-username
MAIL_PASSWORD=your-password
MAIL_ENCRYPTION=tls
MAIL_FROM_ADDRESS="hello@example.com"
MAIL_FROM_NAME="${APP_NAME}"
```
## Mailableクラスの作成
Laravelでは、アプリケーションが送信する各メールを「Mailable」クラスとして表現します。`make:mail` Artisanコマンドでクラスを生成します。
```shell theme={null}
php artisan make:mail OrderShipped
```
生成されたクラスは `app/Mail/` ディレクトリに配置されます。
## Mailableの設定
生成されたMailableクラスには `envelope()`、`content()`、`attachments()` の3つのメソッドがあります。
```php theme={null}
[
'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
'name' => env('MAIL_FROM_NAME', 'Example'),
],
```
### メール本文の設定
`content()` メソッドでBladeテンプレートを指定します。コンストラクターで `public` プロパティに設定したデータは、自動的にテンプレートで利用できます。
```php theme={null}
public function content(): Content
{
return new Content(
view: 'mail.orders.shipped',
);
}
```
対応するBladeテンプレート (`resources/views/mail/orders/shipped.blade.php`) を作成します。
```blade theme={null}
ご注文が発送されました
注文番号: {{ $order->id }}
合計金額: ¥{{ number_format($order->total) }}
ご注文いただきありがとうございました。
```
データを `with` パラメーターで明示的に渡すこともできます。この場合はプロパティを `protected` または `private` にします。
```php theme={null}
public function __construct(
protected Order $order,
) {}
public function content(): Content
{
return new Content(
view: 'mail.orders.shipped',
with: [
'orderId' => $this->order->id,
'total' => $this->order->total,
],
);
}
```
## メールの送信
`Mail` ファサードの `to()` メソッドで宛先を指定し、`send()` でメールを送信します。
```mermaid theme={null}
flowchart TD
A["Mail::to()->send(new OrderShipped())"] --> B{"ShouldQueue
実装?"}
B -- "No" --> C["同期送信
Mailerへ"]
B -- "Yes" --> D["キューに登録
バックグラウンド送信"]
D --> C
C --> E{"MAILドライバー"}
E --> F["smtp"]
E --> G["ses / mailgun
/ postmark"]
E --> H["log
(開発用)"]
```
```php theme={null}
order_id);
Mail::to($request->user())->send(new OrderShipped($order));
return redirect('/orders');
}
}
```
CC・BCCも指定できます。
```php theme={null}
Mail::to($request->user())
->cc($ccUsers)
->bcc($bccUsers)
->send(new OrderShipped($order));
```
特定のメーラーを使って送信するには `mailer()` メソッドを使います。
```php theme={null}
Mail::mailer('postmark')
->to($request->user())
->send(new OrderShipped($order));
```
## キューを使ったメール送信
メール送信はレスポンスタイムに影響するため、キューを使ってバックグラウンドで送信することを推奨します。
```php theme={null}
Mail::to($request->user())->queue(new OrderShipped($order));
```
キューを使うには、事前にキューの設定とワーカーの起動が必要です。
遅延送信も可能です。
```php theme={null}
Mail::to($request->user())
->later(now()->plus(minutes: 10), new OrderShipped($order));
```
Mailableクラスに `ShouldQueue` を実装すると、`send()` を呼び出しても常にキューに入るようになります。
```php theme={null}
use Illuminate\Contracts\Queue\ShouldQueue;
class OrderShipped extends Mailable implements ShouldQueue
{
// ...
}
```
## Markdown Mailの作成
Markdown形式のメールを使うと、Laravelが提供する美しいレスポンシブなHTMLテンプレートを活用できます。
### Markdown Mailableの生成
`--markdown` オプションを付けてMailableを生成します。
```shell theme={null}
php artisan make:mail OrderShipped --markdown=mail.orders.shipped
```
`content()` メソッドで `markdown` パラメーターを使います。
```php theme={null}
use Illuminate\Mail\Mailables\Content;
public function content(): Content
{
return new Content(
markdown: 'mail.orders.shipped',
with: [
'url' => route('orders.show', $this->order),
],
);
}
```
### Markdownテンプレートの記述
Laravelが提供するBladeコンポーネントを使ってメール本文を作成します。
```blade theme={null}
# ご注文が発送されました
ご注文が発送されましたのでお知らせします。
注文を確認する
ご利用ありがとうございます。
{{ config('app.name') }}
```
利用可能なコンポーネントは次のとおりです。
| コンポーネント | 説明 |
| ------------------ | ---------------------------------------------------- |
| `` | ボタンリンク (`color` に `primary`・`success`・`error` を指定可能) |
| `` | 目立つパネルエリア |
| `` | Markdown形式のテーブル |
Markdownメールは、同時にプレーンテキスト版も自動生成されます。HTMLメールに対応していないメールクライアントでも読めます。
## メールのプレビュー
ルートでMailableインスタンスを返すと、ブラウザでメールをプレビューできます。開発中の確認に便利です。
```php theme={null}
// routes/web.php
Route::get('/mailable', function () {
$order = App\Models\Order::first();
return new App\Mail\OrderShipped($order);
});
```
## ローカル開発でのメール
本番環境でメールを誤送信しないよう、ローカル開発では [Mailpit](https://github.com/axllent/mailpit) などのツールを使うと便利です。
```ini theme={null}
# .env (Mailpit)
MAIL_MAILER=smtp
MAIL_HOST=127.0.0.1
MAIL_PORT=1025
```
`Laragon` や `Laravel Herd` では Mailpit がデフォルトで含まれています。
`log` ドライバーを使うとメールの内容がログファイルに記録されます。メール送信の確認だけであれば最も手軽な方法です。
```ini theme={null}
MAIL_MAILER=log
```
## まとめ
| やりたいこと | 方法 |
| ----------------- | --------------------------------- |
| Mailableを作成する | `php artisan make:mail ClassName` |
| 送信者を設定する | `envelope()` の `from` パラメーター |
| Bladeテンプレートを使う | `content()` の `view` パラメーター |
| Markdownテンプレートを使う | `content()` の `markdown` パラメーター |
| メールを送信する | `Mail::to()->send()` |
| キューで送信する | `Mail::to()->queue()` |
| 遅延送信する | `Mail::to()->later()` |