# 通知設計書 2-VerifyEmail

## 概要

本ドキュメントは、Laravel フレームワークにおけるメールアドレス確認通知（VerifyEmail）の設計仕様を定義する。この通知は、ユーザー登録時やメールアドレス変更時に、メールアドレスの所有権を確認するための署名付き URL を送信するために使用される。

### 本通知の処理概要

VerifyEmail 通知は、ユーザーのメールアドレスが有効であることを確認するための署名付き URL をメールで送信する機能を提供する。

**業務上の目的・背景**：ユーザー登録時に入力されたメールアドレスが実際にユーザー本人のものであることを確認する必要がある。この通知により、不正なメールアドレスでの登録を防止し、重要な通知が確実にユーザーに届くことを保証する。また、スパムアカウントの作成を抑止する効果もある。

**通知の送信タイミング**：Registered イベントが発火されたとき（通常はユーザー登録完了時）に SendEmailVerificationNotification リスナーにより自動送信される。MustVerifyEmail インターフェースを実装し、かつメールが未確認のユーザーに対してのみ送信される。

**通知の受信者**：新規登録したユーザー、またはメールアドレス確認を再リクエストしたユーザー本人。MustVerifyEmail インターフェースを実装したユーザーモデルの getEmailForVerification() メソッドで取得されるメールアドレスに送信される。

**通知内容の概要**：メールアドレス確認用の署名付き一時 URL が含まれる。この URL はユーザー ID とメールアドレスのハッシュをパラメータとして持ち、有効期限が設定されている。

**期待されるアクション**：受信者はメール内の「Verify Email Address」ボタンをクリックしてメールアドレスを確認する。アカウントを作成していない場合は、メールを無視するよう案内される。

## 通知種別

メール（mail チャネル）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（ShouldQueue 未実装のため） |
| 優先度 | 中（デフォルト） |
| リトライ | 無（基本実装では未対応） |

### 送信先決定ロジック

MustVerifyEmail トレイトの `getEmailForVerification()` メソッドにより、ユーザーモデルの `email` プロパティが取得され、送信先として使用される。

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | アプリケーション設定による（config/mail.php の from 設定） |
| 送信元名称 | アプリケーション設定による |
| 件名 | "Verify Email Address"（Lang::get による翻訳対応） |
| 形式 | HTML + テキスト（Markdown テンプレート使用） |

### 本文テンプレート

```
Please click the button below to verify your email address.

[Verify Email Address] ボタン

If you did not create an account, no further action is required.
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 本通知には添付ファイルはない |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| id | ユーザー ID | Notifiable::getKey() | Yes |
| hash | メールアドレスのハッシュ | sha1(getEmailForVerification()) | Yes |
| url | 確認用 URL | verificationUrl() メソッドで生成 | Yes |
| expiration | 有効期限 | Carbon::now()->addMinutes(Config::get('auth.verification.expire', 60)) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| イベント | Registered イベント発火 | MustVerifyEmail 実装かつ未確認 | ユーザー登録完了時に自動送信 |
| API/画面操作 | sendEmailVerificationNotification() 呼び出し | なし（明示的な呼び出し） | 再送リクエスト時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| MustVerifyEmail 未実装 | ユーザーモデルが MustVerifyEmail インターフェースを実装していない場合 |
| メール確認済み | hasVerifiedEmail() が true を返す場合（email_verified_at が設定済み） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Registered イベント発火] --> B[SendEmailVerificationNotification リスナー]
    B --> C{MustVerifyEmail 実装?}
    C -->|No| D[送信スキップ]
    C -->|Yes| E{メール確認済み?}
    E -->|Yes| D
    E -->|No| F[sendEmailVerificationNotification 呼び出し]
    F --> G[VerifyEmail 通知作成]
    G --> H[verificationUrl 生成]
    H --> I[署名付き一時 URL 作成]
    I --> J[toMail メソッド実行]
    J --> K[MailMessage 生成]
    K --> L[MailChannel::send 実行]
    L --> M[メール送信]
    M --> N[終了]
    D --> N
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| users | ユーザー情報取得 | MustVerifyEmail インターフェース実装モデル |

### テーブル別参照項目詳細

#### users

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | URL パラメータ生成 | getKey() メソッド経由 |
| email | 確認対象アドレス、ハッシュ生成 | getEmailForVerification() メソッド経由 |
| email_verified_at | 確認状態チェック | hasVerifiedEmail() メソッド経由 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 通知送信時にはテーブル更新なし |

**補足**: メール確認 URL をクリックした後の処理で、`markEmailAsVerified()` メソッドにより `email_verified_at` カラムが更新される。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| メール送信失敗 | SMTP エラー等 | TransportException がスローされる |
| URL 生成失敗 | verification.verify ルート未定義 | RouteNotFoundException がスローされる |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（基本実装ではリトライなし） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 設定なし（アプリケーション側で実装可能） |
| 1日あたり上限 | 設定なし（アプリケーション側で実装可能） |

### 配信時間帯

時間帯による制限なし（即座に送信）

## セキュリティ考慮事項

- URL は署名付き（URL::temporarySignedRoute 使用）で改ざん検知が可能
- URL には有効期限が設定されている（デフォルト 60 分）
- メールアドレスは SHA1 ハッシュ化して URL パラメータに含める
- ユーザー ID と メールハッシュの組み合わせで本人確認
- createUrlUsing() でカスタム URL 生成が可能（セキュリティ要件に応じたカスタマイズ用）

## 備考

- toMailUsing() メソッドでメール内容をカスタマイズ可能
- createUrlUsing() メソッドで確認 URL をカスタマイズ可能
- 多言語対応（Lang::get 使用）
- MailMessage のデフォルト Markdown テンプレート: `notifications::email`
- 確認後の状態更新は markEmailAsVerified() メソッドで行う

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

まず、VerifyEmail 通知で使用されるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | VerifyEmail.php | `src/Illuminate/Auth/Notifications/VerifyEmail.php` | $createUrlCallback（19行目）、$toMailCallback（26行目）の静的プロパティを確認 |

**読解のコツ**: ResetPassword とは異なり、VerifyEmail はコンストラクタでトークンを受け取らない。URL 生成時に notifiable から必要な情報を取得する。

#### Step 2: エントリーポイントを理解する

処理の起点となるファイル・関数を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | SendEmailVerificationNotification.php | `src/Illuminate/Auth/Listeners/SendEmailVerificationNotification.php` | handle() メソッド（16-21行目）が Registered イベントのリスナー |
| 2-2 | MustVerifyEmail.php | `src/Illuminate/Auth/MustVerifyEmail.php` | sendEmailVerificationNotification() メソッド（47-51行目）で実際に通知を発火 |

**主要処理フロー**:
1. **16行目**: handle() で Registered イベントを受信
2. **18行目**: MustVerifyEmail インターフェースの実装確認
3. **18行目**: hasVerifiedEmail() で未確認かチェック
4. **19行目**: sendEmailVerificationNotification() 呼び出し
5. **50行目**: `$this->notify(new VerifyEmail)` で通知を発火

#### Step 3: 通知クラスの処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | VerifyEmail.php | `src/Illuminate/Auth/Notifications/VerifyEmail.php` | via() メソッド（34-37行目）で mail チャネルを指定、toMail() メソッド（45-54行目）でメール内容を構築 |

**主要処理フロー**:
- **34-37行目**: via() メソッドで ['mail'] を返却
- **45-54行目**: toMail() でカスタムコールバックまたはデフォルトのメール生成
- **62-69行目**: buildMailMessage() で MailMessage を構築
- **77-91行目**: verificationUrl() で署名付き一時 URL を生成

#### Step 4: URL 生成処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | VerifyEmail.php | `src/Illuminate/Auth/Notifications/VerifyEmail.php` | verificationUrl() メソッド（77-91行目）で URL::temporarySignedRoute を使用 |

**主要処理フロー**:
- **79-81行目**: カスタムコールバックがあれば使用
- **83-90行目**: デフォルトでは URL::temporarySignedRoute で署名付き URL 生成
- **85行目**: 有効期限は config('auth.verification.expire', 60) 分後
- **87行目**: ユーザー ID を 'id' パラメータに設定
- **88行目**: メールアドレスの SHA1 ハッシュを 'hash' パラメータに設定

#### Step 5: MustVerifyEmail トレイトを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 5-1 | MustVerifyEmail.php | `src/Illuminate/Auth/MustVerifyEmail.php` | hasVerifiedEmail()（14-17行目）、markEmailAsVerified()（24-29行目）、getEmailForVerification()（58-61行目）の各メソッドを確認 |

**主要処理フロー**:
- **14-17行目**: hasVerifiedEmail() で email_verified_at が null でないことを確認
- **24-29行目**: markEmailAsVerified() で email_verified_at を現在時刻に更新
- **35-41行目**: markEmailAsUnverified() で email_verified_at を null に設定
- **58-61行目**: getEmailForVerification() で $this->email を返却

### プログラム呼び出し階層図

```
Registered イベント発火
    │
    └─ SendEmailVerificationNotification::handle()
           │
           ├─ MustVerifyEmail インターフェース確認
           │
           └─ User::sendEmailVerificationNotification()
                  │
                  └─ User::notify(new VerifyEmail)
                         │
                         └─ NotificationSender::send()
                                │
                                └─ NotificationSender::sendNow()
                                       │
                                       └─ NotificationSender::sendToNotifiable()
                                              │
                                              └─ ChannelManager::driver('mail')
                                                     │
                                                     └─ MailChannel::send()
                                                            │
                                                            └─ VerifyEmail::toMail()
                                                                   │
                                                                   ├─ verificationUrl()
                                                                   │      │
                                                                   │      └─ URL::temporarySignedRoute()
                                                                   │
                                                                   └─ MailMessage 構築
```

### データフロー図

```
[入力]                          [処理]                                [出力]

Registered イベント    ───▶  SendEmailVerificationNotification
    │                                │
    │                                ▼
    │                        MustVerifyEmail 確認
    │                                │
    │                                ▼
User (notifiable)     ───▶  sendEmailVerificationNotification()
                                    │
                                    ▼
                            VerifyEmail::toMail()
                                    │
                                    ▼
                            verificationUrl()
                                    │
                                    ├─ getKey() ─────▶ id パラメータ
                                    │
                                    └─ sha1(getEmailForVerification()) ─────▶ hash パラメータ
                                    │
                                    ▼
                            URL::temporarySignedRoute() ───▶ 署名付き URL
                                    │
                                    ▼
                            MailChannel::send()         ───▶  メール送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| VerifyEmail.php | `src/Illuminate/Auth/Notifications/VerifyEmail.php` | ソース | 通知クラス本体 |
| MustVerifyEmail.php | `src/Illuminate/Auth/MustVerifyEmail.php` | ソース | ユーザーモデル用トレイト |
| SendEmailVerificationNotification.php | `src/Illuminate/Auth/Listeners/SendEmailVerificationNotification.php` | ソース | Registered イベントリスナー |
| MustVerifyEmail.php (Contract) | `src/Illuminate/Contracts/Auth/MustVerifyEmail.php` | ソース | インターフェース定義 |
| NotificationSender.php | `src/Illuminate/Notifications/NotificationSender.php` | ソース | 通知送信エンジン |
| MailChannel.php | `src/Illuminate/Notifications/Channels/MailChannel.php` | ソース | メールチャネル実装 |
| MailMessage.php | `src/Illuminate/Notifications/Messages/MailMessage.php` | ソース | メールメッセージ構築 |
| Notification.php | `src/Illuminate/Notifications/Notification.php` | ソース | 通知基底クラス |
| Registered.php | `src/Illuminate/Auth/Events/Registered.php` | ソース | ユーザー登録イベント |
| Verified.php | `src/Illuminate/Auth/Events/Verified.php` | ソース | メール確認完了イベント |
