# 通知設計書 7-Customer Register

## 概要

本ドキュメントは、Shopwareの顧客登録完了時に送信される「Customer Register」ウェルカムメール通知の設計書である。この通知は、新規顧客がアカウント登録を完了した際に送信される歓迎メールである。

### 本通知の処理概要

Customer Register通知は、顧客が新規アカウント登録を完了した際に、ウェルカムメールを送信する機能である。ダブルオプトイン方式が無効の場合、または確認完了後に送信される。

**業務上の目的・背景**：ECサイトにおいて、新規顧客の獲得は重要なビジネス目標である。登録完了時にウェルカムメールを送信することで、顧客との関係構築を開始し、サービス利用への期待を高める。また、登録が正常に完了したことをユーザーに確認させる役割もある。

**通知の送信タイミング**：ダブルオプトイン設定が無効の場合は登録処理完了直後、有効の場合は確認処理完了後にCustomerRegisterEventがディスパッチされてメールが送信される。

**通知の受信者**：登録を完了した顧客。CustomerEntityから取得したメールアドレスに送信される。

**通知内容の概要**：アカウント登録完了を歓迎するメール。顧客情報、販売チャネル情報を含む。テンプレートタイプは「customer_register」。

**期待されるアクション**：受信者は登録完了を確認し、ショップでの購入活動を開始する。

## 通知種別

メール通知

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### メール通知の場合

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

### 本文テンプレート

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

利用可能変数:
- customer: 顧客エンティティ
- salesChannel: 販売チャネル情報
```

### 添付ファイル

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

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| customer | 顧客情報 | CustomerEntity | Yes |
| salesChannel | 販売チャネル情報 | SalesChannelContext | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | POST /store-api/account/register | doubleOptIn無効、guest=false | 登録API |
| API | POST /store-api/account/register-confirm | doubleOptIn有効、確認完了、guest=false | 確認API |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ゲスト登録 | guest=trueの場合はGuestCustomerRegisterEventを発火 |
| doubleOptIn有効 | 確認完了前は送信しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[顧客登録リクエスト] --> B[POST /store-api/account/register]
    B --> C[バリデーション]
    C --> D[顧客データ作成]
    D --> E{doubleOptIn設定?}
    E -->|有効| F[CustomerDoubleOptInRegistrationEvent]
    E -->|無効| G{guest?}
    G -->|true| H[GuestCustomerRegisterEvent]
    G -->|false| I[CustomerRegisterEvent]
    I --> J[Flow/メール送信処理]
    J --> K[ウェルカムメール送信]

    L[確認URL クリック] --> M[POST /store-api/account/register-confirm]
    M --> N[確認処理]
    N --> O{guest?}
    O -->|false| I
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| customer | 顧客情報取得 | 登録データ |
| sales_channel | 販売チャネル情報 | - |
| customer_group | 顧客グループ | - |

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

#### customer

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 識別子 | PRIMARY KEY |
| email | メールアドレス | メール送信先 |
| first_name | 名 | 受信者名 |
| last_name | 姓 | 受信者名 |
| guest | ゲストフラグ | イベント選択 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| customer | INSERT | 顧客レコード作成 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| バリデーションエラー | 必須項目不足 | ConstraintViolationException |
| メール重複 | 既存顧客と同じメール | CustomerEmailUniqueバリデーション |
| パスワード不正 | パスワードポリシー違反 | バリデーションエラー |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（登録操作はレート制限対象外） |

### 配信時間帯

制限なし

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

- メールアドレスのIDN変換
- パスワードのハッシュ化保存
- storefrontUrl検証
- メール一意性チェック

## 備考

- イベント名: checkout.customer.register
- テンプレートタイプ: customer_register（MAILTYPE_CUSTOMER_REGISTER）
- ゲスト登録の場合はGuestCustomerRegisterEventを使用
- 登録後に自動ログインされる

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: ShopwareSalesChannelEventインターフェースの実装により、SalesChannelContextが利用可能。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | RegisterRoute.php | `src/Core/Checkout/Customer/SalesChannel/RegisterRoute.php` | 登録処理全体のフローを確認 |

**主要処理フロー**:
1. **行101-267**: register() - メイン処理
2. **行178**: doubleOptInデータ追加
3. **行205-214**: doubleOptIn有効時のイベント
4. **行252-256**: 通常登録時のイベント分岐

#### Step 3: イベント発火条件を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | RegisterRoute.php | `src/Core/Checkout/Customer/SalesChannel/RegisterRoute.php` | guest判定によるイベント選択 |

**主要処理フロー**:
- **行252-256**: guest判定とイベント発火

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

```
POST /store-api/account/register
    │
    └─ RegisterRoute::register()
           │
           ├─ validateRegistrationData()
           │
           ├─ mapCustomerData()
           │
           ├─ addDoubleOptInData()
           │      └─ doubleOptIn設定確認
           │
           ├─ customerRepository::create()
           │
           └─ イベント発火分岐
                  │
                  ├─ [doubleOptIn有効]
                  │      └─ CustomerDoubleOptInRegistrationEvent
                  │
                  └─ [doubleOptIn無効]
                         │
                         ├─ [guest=false] CustomerRegisterEvent
                         │
                         └─ [guest=true] GuestCustomerRegisterEvent
```

### データフロー図

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

RequestDataBag           RegisterRoute                   CustomerResponse
- email                  register()
- password                    │
- firstName                   ▼
- lastName               バリデーション
- billingAddress              │
- shippingAddress             ▼
- storefrontUrl          顧客データマッピング
                              │
                              ▼
                         customerRepository::create()
                              │
                              ▼
                         CustomerRegisterEvent
                         - salesChannelContext
                         - customer
                              │
                              ▼
                         Flow/Mail送信
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| RegisterRoute.php | `src/Core/Checkout/Customer/SalesChannel/RegisterRoute.php` | ソース | 登録APIエンドポイント |
| CustomerRegisterEvent.php | `src/Core/Checkout/Customer/Event/CustomerRegisterEvent.php` | ソース | イベントクラス |
| GuestCustomerRegisterEvent.php | `src/Core/Checkout/Customer/Event/GuestCustomerRegisterEvent.php` | ソース | ゲスト用イベント |
| MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | ソース | テンプレートタイプ定義 |
| CustomerDefinition.php | `src/Core/Checkout/Customer/CustomerDefinition.php` | ソース | エンティティ定義 |
| CustomerFlowEventsSubscriber.php | `src/Core/Checkout/Customer/Subscriber/CustomerFlowEventsSubscriber.php` | ソース | イベント変換 |
