# 通知設計書 3-Newsletter Registration

## 概要

本ドキュメントは、Shopwareのニュースレター登録機能における「Newsletter Registration」メール通知の設計書である。この通知は、ユーザーがニュースレターに登録した際にダブルオプトイン確認のために送信されるメール通知である。

### 本通知の処理概要

Newsletter Registration通知は、ストアフロントでユーザーがニュースレター登録を行った際に、登録確認用のリンクを含むメールを送信する機能である。GDPR対応のダブルオプトイン方式を採用している。

**業務上の目的・背景**：EU一般データ保護規則（GDPR）では、ニュースレター配信において明示的な同意が必要とされる。ダブルオプトイン方式により、メールアドレスの正当な所有者であることを確認し、スパム登録や不正利用を防止する。

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

**通知の受信者**：ニュースレター登録フォームに入力されたメールアドレスの所有者。登録時に入力された名前（firstName + lastName）または、名前が未入力の場合はメールアドレスが受信者名として使用される。

**通知内容の概要**：ニュースレター登録の確認を求めるメール。確認用URLが含まれ、このURLにアクセスすることで登録が完了する。テンプレートタイプは「newsletter」。

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

## 通知種別

メール通知

## 送信仕様

### 基本情報

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

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

1. NewsletterRegisterEventからMailRecipientStructを取得
2. newsletterRecipient.getEmail()でメールアドレスを取得
3. firstName + lastNameがある場合はそれを受信者名に使用
4. なければメールアドレスを受信者名に使用

## 通知テンプレート

### メール通知の場合

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

### 本文テンプレート

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

利用可能変数:
- newsletterRecipient: ニュースレター受信者エンティティ
- url: 確認用URL
- salesChannel: 販売チャネル情報
```

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | POST /store-api/newsletter/subscribe | doubleOptInが有効、かつ未確認の場合 | ニュースレター登録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[newsletter_recipientにUPSERT]
    E -->|確認済み| Z[何もしない]
    F --> G{doubleOptIn設定?}
    G -->|有効| H[NewsletterRegisterEventディスパッチ]
    G -->|無効| I[NewsletterConfirmEventディスパッチ]
    H --> J[Flow/メール送信処理]
    J --> K[確認メール送信]
    I --> L[確認完了メール送信]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| newsletter_recipient | 受信者情報取得 | メールアドレス、名前等 |
| sales_channel | 販売チャネル情報 | ドメインURL等 |
| sales_channel_domain | ストアフロントURL | 確認URL生成 |
| system_config | 設定値取得 | doubleOptIn設定等 |

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

#### newsletter_recipient

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 識別子 | PRIMARY KEY |
| email | メールアドレス | メール送信先 |
| first_name | 名 | 受信者名生成 |
| last_name | 姓 | 受信者名生成 |
| hash | 確認用ハッシュ | URL生成 |
| status | 登録状態 | 送信判定 |
| sales_channel_id | 販売チャネルID | - |

### 更新テーブル一覧

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

#### newsletter_recipient

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPSERT | id | UUID | 新規の場合Uuid::randomHex() |
| UPSERT | email | 入力値 | メールアドレス |
| UPSERT | status | 'notSet' | doubleOptIn有効時 |
| UPSERT | hash | UUID | Uuid::randomHex() |
| UPSERT | language_id | Context値 | 言語ID |
| UPSERT | sales_channel_id | Context値 | 販売チャネルID |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| バリデーションエラー | メールアドレス形式不正 | ConstraintViolationException |
| レート制限エラー | 短時間に大量リクエスト | NewsletterException::newsletterThrottled |
| ストアフロントURL不正 | 許可されていないドメイン | バリデーションエラー |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし（リクエスト発生時即時）

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

- メールアドレスのIDN変換（国際化ドメイン対応）
- storefrontUrlの検証（許可されたドメインのみ）
- レート制限によるスパム防止
- ハッシュによる確認URL生成（推測困難）

## 備考

- doubleOptInDomain設定により、確認URLのドメインを上書き可能
- 登録済み顧客の場合、顧客メールアドレスと異なるアドレスでの登録時のみdoubleOptInを適用可能（設定による）
- イベント名: newsletter.register

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | NewsletterRecipientDefinition.php | `src/Core/Content/Newsletter/Aggregate/NewsletterRecipient/NewsletterRecipientDefinition.php` | ニュースレター受信者エンティティの構造 |
| 1-2 | NewsletterRegisterEvent.php | `src/Core/Content/Newsletter/Event/NewsletterRegisterEvent.php` | イベントクラス、利用可能データを確認 |

**読解のコツ**: EventDataCollection::getAvailableData()でテンプレートで利用可能な変数を確認できる。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NewsletterSubscribeRoute.php | `src/Core/Content/Newsletter/SalesChannel/NewsletterSubscribeRoute.php` | APIエンドポイント、処理フローを確認 |

**主要処理フロー**:
1. **行101-184**: subscribe() - メイン処理
2. **行170-175**: doubleOptIn無効時のConfirmイベント発火
3. **行177-181**: doubleOptIn有効時のRegisterイベント発火

#### Step 3: イベントとメール送信を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | NewsletterRegisterEvent.php | `src/Core/Content/Newsletter/Event/NewsletterRegisterEvent.php` | イベント実装、MailAwareインターフェース |

**主要処理フロー**:
- **行36-41**: getAvailableData() - 利用可能データ定義
- **行71-88**: getMailStruct() - メール受信者情報生成

#### Step 4: URL生成ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | NewsletterSubscribeRoute.php | `src/Core/Content/Newsletter/SalesChannel/NewsletterSubscribeRoute.php` | getSubscribeUrl()メソッド |

**主要処理フロー**:
- **行331-360**: getSubscribeUrl() - 確認URL生成

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

```
[API] POST /store-api/newsletter/subscribe
    │
    └─ NewsletterSubscribeRoute::subscribe()
           │
           ├─ DataValidator::validate()
           │
           ├─ RateLimiter::ensureAccepted()
           │
           ├─ newsletterRecipientRepository::upsert()
           │
           ├─ isNewsletterDoi() ─── 判定
           │      │
           │      ├─ [true] ─▶ getSubscribeUrl()
           │      │               │
           │      │               └─ NewsletterRegisterEvent
           │      │                       │
           │      │                       └─ EventDispatcher::dispatch()
           │      │
           │      └─ [false] ─▶ NewsletterConfirmEvent
           │
           └─ NoContentResponse
```

### データフロー図

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

RequestDataBag           NewsletterSubscribeRoute        NoContentResponse
- email                  subscribe()
- firstName                   │
- lastName                    ▼
- storefrontUrl          バリデーション
- option                      │
                              ▼
                         UPSERT newsletter_recipient
                              │
                              ▼
                         URL生成
                         - storefrontUrl
                         - %%HASHEDEMAIL%%
                         - %%SUBSCRIBEHASH%%
                              │
                              ▼
                         NewsletterRegisterEvent
                         - newsletterRecipient
                         - url
                         - salesChannelId
                              │
                              ▼
                         Flow/Mail送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| NewsletterSubscribeRoute.php | `src/Core/Content/Newsletter/SalesChannel/NewsletterSubscribeRoute.php` | ソース | APIエンドポイント |
| NewsletterRegisterEvent.php | `src/Core/Content/Newsletter/Event/NewsletterRegisterEvent.php` | ソース | イベントクラス |
| NewsletterRecipientDefinition.php | `src/Core/Content/Newsletter/Aggregate/NewsletterRecipient/NewsletterRecipientDefinition.php` | ソース | エンティティ定義 |
| NewsletterSubscribeUrlEvent.php | `src/Core/Content/Newsletter/Event/NewsletterSubscribeUrlEvent.php` | ソース | URL生成イベント |
| MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | ソース | テンプレートタイプ定義 |
| FormController.php | `src/Storefront/Controller/FormController.php` | ソース | ストアフロントコントローラー |
