# 通知設計書 6-Newsletter Unsubscribe

## 概要

本ドキュメントは、Shopwareのニュースレター購読解除時に送信される「Newsletter Unsubscribe」通知の設計書である。この通知は、ユーザーがニュースレターの購読を解除した際に発火するイベントベースの通知である。

### 本通知の処理概要

Newsletter Unsubscribe通知は、ユーザーがニュースレター購読を解除した際に、解除完了を通知するためのイベントを発火する。このイベントはFlow/メール送信アクションと連携可能。

**業務上の目的・背景**：GDPRでは、ユーザーが簡単に購読解除できる手段を提供することが求められる。購読解除が正常に処理されたことをユーザーに確認させることで、透明性を確保し、ユーザーの信頼を維持する。

**通知の送信タイミング**：ユーザーがニュースレター購読解除APIを呼び出し、正常に処理が完了した時点でNewsletterUnsubscribeEventがディスパッチされる。

**通知の受信者**：購読解除を行ったユーザー。newsletter_recipientから取得したメールアドレスに送信される。

**通知内容の概要**：購読解除完了を伝えるメール。受信者情報と販売チャネル情報を含む。標準ではメールテンプレートが設定されていない場合もある。

**期待されるアクション**：受信者は購読解除が完了したことを確認する。再購読を希望する場合は、再度登録手続きを行う。

## 通知種別

メール通知（イベントベース）

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### メール通知の場合

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

### 本文テンプレート

```
テンプレートタイプ: 標準定義なし（Flowで設定）

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

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| newsletterRecipient | ニュースレター受信者情報 | NewsletterRecipientEntity | Yes |
| salesChannel | 販売チャネル情報 | SalesChannelContext | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | POST /store-api/newsletter/unsubscribe | バリデーション成功、レコード更新完了 | 購読解除API |
| 画面操作 | ニュースレター購読解除フォーム | 同上 | ストアフロント |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 受信者不存在 | email + salesChannelIdに対応するレコードなし |
| バリデーションエラー | メールアドレス形式不正 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[購読解除リクエスト] --> B[POST /store-api/newsletter/unsubscribe]
    B --> C[メールアドレスバリデーション]
    C -->|OK| D[newsletter_recipient検索]
    C -->|NG| Z1[バリデーションエラー]
    D -->|あり| E[status=optOutに更新]
    D -->|なし| Z2[受信者不存在エラー]
    E --> F[NewsletterUnsubscribeEventディスパッチ]
    F --> G[Flow処理]
    G --> H{メールアクション設定?}
    H -->|あり| I[購読解除確認メール送信]
    H -->|なし| J[処理終了]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| newsletter_recipient | 受信者情報取得 | email + salesChannelIdで検索 |
| salutation | 敬称情報 | アソシエーション |

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

#### newsletter_recipient

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 識別子 | PRIMARY KEY |
| email | メールアドレス | WHERE email = :email |
| sales_channel_id | 販売チャネルID | WHERE sales_channel_id = :id |
| first_name | 名 | 受信者名 |
| last_name | 姓 | 受信者名 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| newsletter_recipient | UPDATE | ステータス更新 |

#### newsletter_recipient

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | id | 既存値 | WHERE条件 |
| UPDATE | status | 'optOut' | 購読解除状態 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| バリデーションエラー | メールアドレス不正 | ConstraintViolationException |
| 受信者不存在 | レコードなし | NewsletterException::recipientNotFound |
| メールパラメータ不足 | email未指定 | NewsletterException::missingEmailParameter |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（購読解除はレート制限対象外） |

### 配信時間帯

制限なし

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

- メールアドレスのバリデーション
- 販売チャネルに紐づく受信者のみ操作可能
- 認証不要でアクセス可能（リンクからの解除を想定）

## 備考

- イベント名: newsletter.unsubscribe
- 標準ではメールテンプレートが設定されていない場合がある
- Flowで明示的にメールアクションを設定する必要がある場合がある
- status=optOutに更新されるが、レコードは削除されない

---

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

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

### 推奨読解順序

#### Step 1: イベントクラスを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | NewsletterUnsubscribeEvent.php | `src/Core/Content/Newsletter/Event/NewsletterUnsubscribeEvent.php` | イベント構造、利用可能データを確認 |

**読解のコツ**: MailAware, FlowEventAwareインターフェースの実装を確認し、このイベントがメール送信可能であることを確認。

#### Step 2: APIエンドポイントを理解する

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

**主要処理フロー**:
1. **行47-69**: unsubscribe() - メイン処理
2. **行50-54**: メールパラメータ検証
3. **行56**: 受信者検索
4. **行59**: status=optOutに設定
5. **行64**: データ更新
6. **行66-67**: イベントディスパッチ

#### Step 3: バリデーションを理解する

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

**主要処理フロー**:
- **行94-100**: getOptOutValidation() - バリデーション定義

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

```
POST /store-api/newsletter/unsubscribe
    │
    └─ NewsletterUnsubscribeRoute::unsubscribe()
           │
           ├─ emailパラメータ検証
           │
           ├─ getNewsletterRecipient()
           │      │
           │      └─ Criteria検索
           │         - email = :email
           │         - salesChannelId = :id
           │
           ├─ DataValidator::validate()
           │      └─ getOptOutValidation()
           │
           ├─ newsletterRecipientRepository::update()
           │      └─ status = 'optOut'
           │
           └─ EventDispatcher::dispatch(NewsletterUnsubscribeEvent)
                  │
                  └─ Flow/Mail処理（設定に依存）
```

### データフロー図

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

RequestDataBag           NewsletterUnsubscribeRoute      NoContentResponse
- email                  unsubscribe()
                              │
                              ▼
                         受信者検索
                         newsletter_recipient
                         WHERE email = :email
                         AND sales_channel_id = :id
                              │
                              ▼
                         ステータス更新
                         status = 'optOut'
                              │
                              ▼
                         NewsletterUnsubscribeEvent
                         - context
                         - newsletterRecipient
                         - salesChannelId
                              │
                              ▼
                         Flow処理（任意）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| NewsletterUnsubscribeRoute.php | `src/Core/Content/Newsletter/SalesChannel/NewsletterUnsubscribeRoute.php` | ソース | APIエンドポイント |
| NewsletterUnsubscribeEvent.php | `src/Core/Content/Newsletter/Event/NewsletterUnsubscribeEvent.php` | ソース | イベントクラス |
| NewsletterException.php | `src/Core/Content/Newsletter/NewsletterException.php` | ソース | 例外クラス |
| NewsletterRecipientDefinition.php | `src/Core/Content/Newsletter/Aggregate/NewsletterRecipient/NewsletterRecipientDefinition.php` | ソース | エンティティ定義 |
| newsletter-form.html.twig | `src/Storefront/Resources/views/storefront/element/cms-element-form/form-types/newsletter-form.html.twig` | テンプレート | ストアフロントフォーム |
