# 通知設計書 12-Customer Group Registration Declined

## 概要

本ドキュメントは、Shopwareにおける顧客グループ登録拒否通知（Customer Group Registration Declined）の設計仕様を記載したものです。管理者が顧客の顧客グループ登録申請を拒否した際に、申請した顧客に対して拒否結果を通知するメール機能について定義します。

### 本通知の処理概要

この通知は、B2B（企業間取引）向け機能の一部として、顧客が特定の顧客グループへの参加を申請し、管理者がその申請を拒否した際に送信されるメール通知です。

**業務上の目的・背景**：ECサイトにおいて、顧客グループへの参加申請は審査制となっており、すべての申請が承認されるわけではありません。拒否の場合も顧客に適切に通知することで、顧客は次のアクション（問い合わせ、別の申請等）を取ることができます。透明性のあるコミュニケーションにより、顧客満足度の維持に貢献します。

**通知の送信タイミング**：管理者が管理画面（Administration）から顧客グループ登録申請を拒否（Decline）した際に、`CustomerGroupRegistrationDeclined`イベントがディスパッチされ、Flowビルダーで設定されたメール送信アクションがトリガーされます。

**通知の受信者**：申請を行った顧客本人。顧客のメールアドレス（`customer.email`）に対して送信されます。

**通知内容の概要**：拒否された顧客グループ名、問い合わせを促すメッセージが含まれます。拒否理由は含まれません。

**期待されるアクション**：顧客は必要に応じてショップに問い合わせを行い、拒否理由の確認や再申請の相談を行うことができます。

## 通知種別

メール通知

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（Flow経由） |
| 優先度 | 中 |
| リトライ | Flowの設定に依存（デフォルト: なし） |

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

イベント発生時に`MailRecipientStruct`が構築され、顧客のメールアドレスと氏名が設定されます。

```php
// CustomerGroupRegistrationDeclined.php 行49-60
public function getMailStruct(): MailRecipientStruct
{
    if ($this->mailRecipientStruct) {
        return $this->mailRecipientStruct;
    }

    return new MailRecipientStruct(
        [
            $this->customer->getEmail() => $this->customer->getFirstName() . ' ' . $this->customer->getLastName(),
        ]
    );
}
```

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | ショップ設定に依存 |
| 送信元名称 | `Shop`（デフォルト） |
| 件名 | `Customer Group Registration Declined`（EN）/ `Kunden Gruppen Registrierung Abgelehnt`（DE） |
| 形式 | HTML/テキスト |

### 本文テンプレート

**英語版（HTML）**:
```html
<div style="font-family:arial; font-size:12px;">
    <br/>
    <p>
        {{ customer.salutation.letterName }} {{ customer.lastName }},<br/>
        <br/>
        Thank you for your interest in the conditions for customer group {{ customerGroup.translated.name }}.<br/>
        Unfortunately we cannot activate your account for this customer group.<br/><br/>

        If you have any questions, please feel free to contact us by phone or mail.
    </p>
</div>
```

**ドイツ語版（HTML）**:
```html
<div style="font-family:arial; font-size:12px;">
    <br/>
    <p>
        {{ customer.salutation.letterName }} {{ customer.lastName }},<br/>
        <br/>
        Vielen Dank für Ihr Interesse an den Konditionen für Kundengruppe {{ customerGroup.translated.name }}.<br/>
        Leider können wir sie nicht für diese Kundengruppe freischalten.<br/>

        Bei Rückfragen aller Art können Sie uns gerne telefonisch oder per Mail diesbezüglich erreichen.
    </p>
</div>
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| `customer` | 顧客エンティティ | CustomerEntity | Yes |
| `customer.salutation.letterName` | 敬称の書面用名称 | customer.salutation | No |
| `customer.lastName` | 顧客の姓 | customer.last_name | Yes |
| `customer.firstName` | 顧客の名 | customer.first_name | Yes |
| `customer.email` | 顧客のメールアドレス | customer.email | Yes |
| `customerGroup` | 顧客グループエンティティ | CustomerGroupEntity | Yes |
| `customerGroup.translated.name` | 顧客グループの翻訳済み名称 | customer_group_translation.name | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API操作 | `customer.group.registration.declined` | 管理者が拒否APIを呼び出した時 | `POST /api/_action/customer-group-registration/decline` |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Flowが設定されていない | Flowビルダーでメール送信アクションが設定されていない場合 |
| 顧客グループ申請がない | `requested_group_id`がnullの場合（silentError=trueでない限りエラー） |
| メールテンプレートが存在しない | 対応するメールテンプレートが削除されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[管理者が拒否APIを呼び出す] --> B[CustomerGroupRegistrationActionController::decline]
    B --> C[顧客データ取得・検証]
    C -->|検証OK| D[CustomerGroupRegistrationDeclinedイベント発火]
    C -->|検証NG| E[エラーレスポンス]
    D --> F[requested_group_idをnullに更新]
    F --> G[Flowエンジンがイベントを検知]
    G --> H[SendMailAction実行]
    H --> I[メールテンプレート取得]
    I --> J[テンプレート変数展開]
    J --> K[メール送信]
    K --> L[終了]
    E --> L
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| customer | 顧客情報の取得 | メール宛先、テンプレート変数 |
| customer_group | 顧客グループ情報の取得 | 申請先グループ（拒否対象） |
| customer_group_translation | グループ名の翻訳取得 | 多言語対応 |
| mail_template | メールテンプレート本文取得 | - |
| mail_template_type | テンプレートタイプの識別 | technical_name = 'customer.group.registration.declined' |

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

#### customer

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 顧客識別 | リクエストで指定されたcustomerIds |
| email | メール送信先 | - |
| first_name | テンプレート変数 | - |
| last_name | テンプレート変数 | - |
| salutation_id | 敬称取得 | JOIN salutation |
| requested_group_id | 申請先グループ | 拒否対象の確認（nullでないこと） |
| sales_channel_id | 販売チャネル | コンテキスト復元 |

#### customer_group

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | グループ識別 | customer.requested_group_id |
| translated.name | グループ名（翻訳済み） | テンプレート変数 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| customer | UPDATE | requested_group_idのクリア |

#### customerテーブル更新

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| UPDATE | requested_group_id | null | 申請をクリア（グループは変更しない） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 顧客未発見 | 指定されたcustomerIdが存在しない | CustomerException::customersNotFound |
| グループ申請なし | requested_group_idがnull | CustomerException::groupRequestNotFound（silentError=false時） |
| 顧客グループ未発見 | 申請先グループが存在しない | CustomerException::customerGroupNotFound |
| メール送信失敗 | SMTPエラー等 | ログ記録、例外は抑止 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Flowの設定に依存 |
| リトライ間隔 | Flowの設定に依存 |
| リトライ対象エラー | 一時的なネットワークエラー |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | システム設定に依存 |
| 1日あたり上限 | システム設定に依存 |

### 配信時間帯

制限なし（管理者操作時に即座に送信）

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

- 管理者権限（API認証）が必要なエンドポイントからのみイベントが発火される
- 顧客のメールアドレスは個人情報として適切に取り扱う
- 拒否理由などのセンシティブな情報はテンプレートに含めない（含める場合は別途設計が必要）

## 備考

- 承認（Accepted）と異なり、拒否の場合はcustomer.group_idは変更されない
- `silentError`パラメータをtrueにすることで、申請がない顧客をスキップ可能
- このイベントは`FlowEventAware`インターフェースを実装しており、Flowビルダーで柔軟にアクションを設定可能

---

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

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

### 推奨読解順序

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

まず、イベントで扱われるデータ構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | CustomerGroupRegistrationDeclined.php | `src/Core/Checkout/Customer/Event/CustomerGroupRegistrationDeclined.php` | イベントクラスの構造、提供されるデータ、実装インターフェース |
| 1-2 | CustomerEntity.php | `src/Core/Checkout/Customer/CustomerEntity.php` | 顧客エンティティの構造、requestedGroupIdフィールド |

**読解のコツ**: `CustomerGroupRegistrationAccepted`とほぼ同一の構造であることを確認。違いは発火タイミングと後続処理（グループ変更の有無）のみ。

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

処理の起点となるコントローラーを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | CustomerGroupRegistrationActionController.php | `src/Core/Checkout/Customer/Api/CustomerGroupRegistrationActionController.php` | declineメソッドの処理フロー |

**主要処理フロー**:
1. **行101**: `decline`メソッドのルート定義（`/api/_action/customer-group-registration/decline`）
2. **行104-108**: リクエストから顧客IDを取得し、顧客データをフェッチ
3. **行109-142**: 各顧客に対してイベントをディスパッチ
4. **行144-152**: requested_group_idをnullに更新

#### Step 3: イベント処理を理解する

イベントがどのように処理されるかを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | SendMailAction.php | `src/Core/Content/Flow/Dispatching/Action/SendMailAction.php` | Flowでのメール送信アクション |
| 3-2 | MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | テンプレートタイプの定数定義（行40） |

#### Step 4: テンプレートを理解する

メールテンプレートの内容を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | MailTemplateContent.php | `src/Core/Migration/Fixtures/MailTemplateContent.php` | デフォルトのメールテンプレート内容（行1167-1204） |

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

```
CustomerGroupRegistrationActionController::decline()
    │
    ├─ fetchCustomers()
    │      └─ customerRepository->search()
    │
    ├─ restorer->restoreByCustomer()
    │
    ├─ customerGroupRepository->search()
    │      └─ 申請先グループを取得
    │
    ├─ eventDispatcher->dispatch(CustomerGroupRegistrationDeclined)
    │      │
    │      └─ FlowExecutor (Subscriber)
    │             │
    │             └─ SendMailAction::handleFlow()
    │
    └─ customerRepository->update()
           └─ requested_group_id = null
```

### データフロー図

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

Request                     CustomerGroupRegistration
(customerIds) ─────────────▶ ActionController::decline()
                                   │
                                   ▼
                            顧客データ取得
                            (customerRepository)
                                   │
                                   ▼
                            申請先グループ取得
                            (customerGroupRepository)
                                   │
                                   ▼
CustomerGroupRegistration   イベントディスパッチ
DeclinedEvent ◀────────────────────┘
      │
      ▼
Flow Engine                 SendMailAction
      │                           │
      ▼                           ▼
MailTemplate               メール送信
(DBから取得) ────────────▶ (emailService)
                                   │
                                   ▼
                            顧客のメールボックス
                                   │
                                   ▼
                            requested_group_id更新
                            (null設定)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| CustomerGroupRegistrationDeclined.php | `src/Core/Checkout/Customer/Event/CustomerGroupRegistrationDeclined.php` | ソース | イベントクラス定義 |
| CustomerGroupRegistrationActionController.php | `src/Core/Checkout/Customer/Api/CustomerGroupRegistrationActionController.php` | ソース | API コントローラー |
| SendMailAction.php | `src/Core/Content/Flow/Dispatching/Action/SendMailAction.php` | ソース | メール送信アクション |
| MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | ソース | テンプレートタイプ定数 |
| MailTemplateContent.php | `src/Core/Migration/Fixtures/MailTemplateContent.php` | フィクスチャ | デフォルトテンプレート内容 |
| Migration1596441551CustomerGroupRegistration.php | `src/Core/Migration/V6_3/Migration1596441551CustomerGroupRegistration.php` | マイグレーション | テンプレート・タイプ登録 |
