# 通知設計書 5-Newsletter Double Opt-in

## 概要

本ドキュメントは、Shopwareのニュースレター登録におけるダブルオプトイン確認メール「Newsletter Double Opt-in」の設計書である。この通知は、No.3「Newsletter Registration」と同じイベント（newsletter.register）で発火するが、テンプレートタイプが異なる別の通知として定義されている。

### 本通知の処理概要

Newsletter Double Opt-in通知は、ニュースレター登録時にダブルオプトイン方式で確認を求めるメールである。登録を完了するための確認リンクを含む。

**業務上の目的・背景**：GDPR対応のダブルオプトイン方式において、ユーザーがメールアドレスの正当な所有者であることを確認する必要がある。この通知は確認用URLを含み、ユーザーにリンクをクリックして登録を確定するよう促す。

**通知の送信タイミング**：ユーザーがニュースレター登録フォームを送信し、システム設定でダブルオプトイン（doubleOptIn）が有効な場合に、NewsletterRegisterEventがディスパッチされてメールが送信される。

**通知の受信者**：ニュースレター登録フォームに入力されたメールアドレスの所有者。

**通知内容の概要**：登録確認を求めるメール。確認用URLが含まれる。テンプレートタイプは「newsletter_do_confirm」（do = double opt-in）。

**期待されるアクション**：受信者はメール内の確認リンクをクリックして、ニュースレター登録を確定する。確認リンクをクリックしない場合、登録は完了しない。

## 通知種別

メール通知

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（Flow/イベント駆動） |
| 優先度 | 高（確認待ちのため） |
| リトライ | メール送信基盤の設定に依存 |

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

1. NewsletterRegisterEventからMailRecipientStructを取得
2. newsletterRecipient.getEmail()でメールアドレスを取得
3. firstName + lastNameまたはemailを受信者名として使用

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | システム設定による |
| 送信元名称 | システム設定による |
| 件名 | テンプレートによる |
| 形式 | HTML/テキスト |

### 本文テンプレート

```
テンプレートタイプ: newsletter_do_confirm

利用可能変数:
- newsletterRecipient: ニュースレター受信者エンティティ
- url: 確認用URL（%%HASHEDEMAIL%%, %%SUBSCRIBEHASH%%を展開済み）
- salesChannel: 販売チャネル情報
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 添付ファイルなし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| newsletterRecipient | ニュースレター受信者情報 | NewsletterRecipientEntity | Yes |
| url | 確認用URL | getSubscribeUrl()生成 | Yes |
| salesChannel | 販売チャネル情報 | SalesChannelContext | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | POST /store-api/newsletter/subscribe | doubleOptIn有効、status=notSet | 登録API |
| 画面操作 | ニュースレター登録フォーム | 同上 | ストアフロント |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| doubleOptIn無効 | 直接登録となりConfirmイベントを発火 |
| 既に確認済み | status=optIn かつ confirmedAtが設定済み |
| レート制限超過 | RateLimiter::NEWSLETTER_FORMによる制限 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ニュースレター登録フォーム送信] --> B[POST /store-api/newsletter/subscribe]
    B --> C[バリデーション]
    C --> D[レート制限チェック]
    D --> E{既存登録?}
    E -->|なし| F[新規INSERT]
    E -->|あり| G{確認済み?}
    G -->|はい| Z[何もしない]
    G -->|いいえ| H[UPDATE]
    F --> I{doubleOptIn設定?}
    H --> I
    I -->|有効| J[status=notSet]
    I -->|無効| K[status=direct]
    J --> L[確認URL生成]
    L --> M[NewsletterRegisterEventディスパッチ]
    M --> N[Flow処理]
    N --> O{テンプレートタイプ}
    O -->|newsletter_do_confirm| P[ダブルオプトインメール送信]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| newsletter_recipient | 受信者情報 | 登録状態確認 |
| sales_channel_domain | ドメイン情報 | URL生成 |
| system_config | 設定値 | doubleOptIn, subscribeUrl |
| customer | 顧客情報 | ログインユーザーのメール比較 |

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

#### newsletter_recipient

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 識別子 | email + salesChannelIdで検索 |
| email | メールアドレス | - |
| status | 登録状態 | 確認済み判定 |
| confirmed_at | 確認日時 | 確認済み判定 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| newsletter_recipient | UPSERT | 受信者レコード |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| バリデーションエラー | 必須項目不足 | ConstraintViolationException |
| レート制限エラー | 大量リクエスト | NewsletterException::newsletterThrottled |
| URL不正 | 許可されていないドメイン | バリデーションエラー |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | メール送信基盤設定に依存 |
| リトライ間隔 | メール送信基盤設定に依存 |
| リトライ対象エラー | 一時的な送信失敗 |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限単位 | クライアントIP |
| 制限キー | RateLimiter::NEWSLETTER_FORM |

### 配信時間帯

制限なし

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

- SHA1ハッシュによるメールアドレスエンコード
- 確認用ハッシュはUUID（推測困難）
- storefrontUrl検証による不正URL防止
- レート制限によるスパム防止

## 備考

- イベント名: newsletter.register（No.3と同じ）
- テンプレートタイプ: newsletter_do_confirm（MAILTYPE_NEWSLETTER_DO_CONFIRM）
- No.3「Newsletter Registration」との違いはFlowで設定されるテンプレートのみ
- "do" は "double opt-in" の略

---

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

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

### 推奨読解順序

#### Step 1: イベントとテンプレートタイプの関係を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | MAILTYPE_NEWSLETTER_DO_CONFIRMの定義 |

**読解のコツ**: テンプレートタイプはFlow/イベントアクション設定でメールテンプレートを選択する際に使用される。同じイベントでも異なるテンプレートを送信可能。

#### Step 2: No.3と同じイベント構造を確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NewsletterRegisterEvent.php | `src/Core/Content/Newsletter/Event/NewsletterRegisterEvent.php` | 利用可能データの確認 |
| 2-2 | NewsletterSubscribeRoute.php | `src/Core/Content/Newsletter/SalesChannel/NewsletterSubscribeRoute.php` | イベント発火ポイントの確認 |

**主要処理フロー**:
- **行177-181** (NewsletterSubscribeRoute): NewsletterRegisterEvent発火
- **行331-360** (NewsletterSubscribeRoute): getSubscribeUrl() - URL生成

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

```
POST /store-api/newsletter/subscribe
    │
    └─ NewsletterSubscribeRoute::subscribe()
           │
           ├─ isNewsletterDoi() ─── doubleOptIn判定
           │      │
           │      └─ [true] ─▶ getSubscribeUrl()
           │                       │
           │                       ├─ systemConfigService::get('core.newsletter.subscribeUrl')
           │                       │
           │                       └─ NewsletterSubscribeUrlEvent（URL変更可能）
           │
           └─ NewsletterRegisterEvent
                  │
                  └─ EventDispatcher::dispatch()
                         │
                         └─ Flow/Mail処理
                                │
                                └─ テンプレート: newsletter_do_confirm
```

### データフロー図

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

RequestDataBag           NewsletterSubscribeRoute        メール送信
- email                  subscribe()
- storefrontUrl               │
- option=subscribe            ▼
                         doubleOptIn判定
                         [有効]
                              │
                              ▼
                         URL生成
                         storefrontUrl + /newsletter-subscribe
                         ?em=%%HASHEDEMAIL%%
                         &hash=%%SUBSCRIBEHASH%%
                              │
                              ▼
                         NewsletterRegisterEvent
                              │
                              ▼
                         Flow処理
                         テンプレート選択: newsletter_do_confirm
                              │
                              ▼
                         メール送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| NewsletterSubscribeRoute.php | `src/Core/Content/Newsletter/SalesChannel/NewsletterSubscribeRoute.php` | ソース | APIエンドポイント |
| NewsletterRegisterEvent.php | `src/Core/Content/Newsletter/Event/NewsletterRegisterEvent.php` | ソース | イベントクラス |
| MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | ソース | テンプレートタイプ定義 |
| NewsletterSubscribeUrlEvent.php | `src/Core/Content/Newsletter/Event/NewsletterSubscribeUrlEvent.php` | ソース | URL変更イベント |
