# 通知設計書 2-BaseMailer#welcome_with_headers

## 概要

本ドキュメントは、Rails ActionMailerフレームワークにおけるBaseMailer#welcome_with_headersメソッドによるカスタムヘッダー付きウェルカムメール通知の設計を記述する。

### 本通知の処理概要

BaseMailer#welcome_with_headersは、カスタムヘッダーを動的に設定可能なウェルカムメールを送信するためのテスト用メーラーメソッドである。このメソッドは、ActionMailerのheadersメソッドを使用したカスタムヘッダー設定機能を実証するために設計されている。

**業務上の目的・背景**：メール配信において、トラッキング用ヘッダー、メッセージID参照、ドメイン固有のカスタムヘッダーなど、標準ヘッダー以外の情報を付与する必要がある場合に使用される。本実装はテスト用であり、headersメソッドへのハッシュ渡しによる複数カスタムヘッダーの一括設定機能の動作確認を主目的とする。

**通知の送信タイミング**：メーラーメソッドが呼び出された時点で送信される。呼び出し時にカスタムヘッダーをハッシュ形式で渡すことで、任意のヘッダーを設定できる。

**通知の受信者**：デフォルトでは`system@test.lindsaar.net`宛に送信される（BaseMailerのクラスデフォルト設定）。

**通知内容の概要**：HTMLテンプレート（welcome_with_headers.html.erb）を使用するが、テンプレート内容は空。呼び出し時に渡されたカスタムヘッダーがメールに付与される。

**期待されるアクション**：受信者はカスタムヘッダー付きのメールを受信し、メールクライアントやシステムがそのヘッダー情報を利用できる。テスト用途では、headersメソッドによるカスタムヘッダー設定が正常に動作することを確認する。

## 通知種別

メール

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（deliver_now）/ 非同期（deliver_later） |
| 優先度 | 中（デフォルト） |
| リトライ | 配信メソッドに依存 |

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

BaseMailerのクラスデフォルト設定として`system@test.lindsaar.net`が指定されている。

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | jose@test.plataformatec.com |
| 送信元名称 | （未設定） |
| 件名 | Welcome with headers（I18nデフォルト） |
| 形式 | text/html |

### 本文テンプレート

```html
（空のテンプレート）
```

テンプレートファイル: `actionmailer/test/fixtures/base_mailer/welcome_with_headers.html.erb`

### 添付ファイル

本メソッドでは添付ファイルは使用されない。

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| （なし） | 本テンプレートでは変数を使用しない | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | `BaseMailer.welcome_with_headers(hash)` メソッド実行 | なし（常に送信） | カスタムヘッダーをハッシュで渡す |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| perform_deliveries = false | ActionMailerの設定で配信を無効化している場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BaseMailer.welcome_with_headers hash 呼び出し] --> B[MessageDelivery オブジェクト生成]
    B --> C[deliver_now/deliver_later 呼び出し]
    C --> D[メーラーインスタンス生成]
    D --> E[welcome_with_headers メソッド実行]
    E --> F[headers hash でカスタムヘッダー一括設定]
    F --> G[mail メソッド呼び出し]
    G --> H[テンプレート welcome_with_headers.html.erb レンダリング]
    H --> I[Mail::Message 生成]
    I --> J[配信処理]
    J --> K[終了]
```

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

### 参照テーブル一覧

本メソッドはデータベースを参照しない（テスト用メーラー）。

### 更新テーブル一覧

本メソッドはデータベースを更新しない。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| テンプレート未検出 | welcome_with_headers.html.erbが存在しない場合 | ActionView::MissingTemplate例外 |
| 不正なヘッダー | 無効なヘッダー名/値を渡した場合 | Mail gem側でエラー |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | ActiveJob設定に依存（deliver_later使用時） |
| リトライ間隔 | ActiveJob設定に依存 |
| リトライ対象エラー | StandardError |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 設定なし |
| 1日あたり上限 | 設定なし |

### 配信時間帯

制限なし

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

- カスタムヘッダーの値はサニタイズされないため、外部入力を使用する場合は注意が必要
- テスト用メーラーのため、本番環境での使用は非推奨

## 備考

- headersメソッドにハッシュを渡すことで、複数のカスタムヘッダーを一度に設定可能
- welcomeメソッドとの違い: welcomeは`headers["X-SPAM"] = value`形式、本メソッドは`headers(hash)`形式
- In-Reply-Toなどの返信関連ヘッダーの設定に適している

---

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

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

### 推奨読解順序

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

headersメソッドへ渡すハッシュの構造と、Mail::Messageへの反映を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | base.rb | `actionmailer/lib/action_mailer/base.rb` | L684-724: headersメソッドの実装と使用方法 |

**読解のコツ**: headersメソッドは引数の有無で動作が変わる。引数ありの場合は@_message.headers(args)でヘッダー設定、引数なしの場合は@_messageを返す。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | base_mailer.rb | `actionmailer/test/mailers/base_mailer.rb` | L15-18: welcome_with_headersメソッドの実装 |

**主要処理フロー**:
1. **L16**: `headers hash` - ハッシュ全体をheadersメソッドに渡してカスタムヘッダー設定
2. **L17**: `mail` - 引数なしでmailメソッド呼び出し（デフォルト設定を使用）

#### Step 3: headersメソッドの動作を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | base.rb | `actionmailer/lib/action_mailer/base.rb` | L718-724: headersメソッドの条件分岐 |

**主要処理フロー**:
- **L719-720**: `if args` then `@_message.headers(args)` - ハッシュが渡された場合、Mail::Messageのheadersメソッドに委譲
- **L721-722**: `else @_message` - 引数なしの場合、Mail::Messageオブジェクト自体を返す

#### Step 4: テストケースで動作を確認する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | base_test.rb | `actionmailer/test/base_test.rb` | L117-123: カスタムヘッダーのテスト |

**主要処理フロー**:
- **L118-119**: テスト用ハッシュの定義（X-Special-Domain-Specific-Header, In-Reply-To）
- **L120**: `BaseMailer.welcome_with_headers(hash)`の呼び出し
- **L121-122**: カスタムヘッダーが正しく設定されていることを検証

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

```
BaseMailer.welcome_with_headers(hash)
    │
    ├─ ActionMailer::Base.method_missing
    │      └─ MessageDelivery.new(self, :welcome_with_headers, hash)
    │
    └─ MessageDelivery#deliver_now
           │
           ├─ processed_mailer
           │      └─ BaseMailer.new.process(:welcome_with_headers, hash)
           │             │
           │             └─ BaseMailer#welcome_with_headers(hash)
           │                    │
           │                    ├─ headers(hash)
           │                    │      └─ @_message.headers(hash)
           │                    │             └─ Mail::Message#headers
           │                    │
           │                    └─ mail
           │                           └─ (引数なしでデフォルト設定使用)
           │
           └─ message.deliver
```

### データフロー図

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

カスタムヘッダー Hash      ───▶ headers(hash)             ───▶ Mail::Message
  {                                │                              (カスタムヘッダー付き)
    "X-Custom" => "Value",         ▼
    "In-Reply-To" => "..."    ───▶ @_message.headers(hash)
  }                                │
                                   ▼
                             ───▶ mail()
                                   │
                                   ├─ apply_defaults
                                   │    (from, to, reply_to適用)
                                   │
                                   └─ collect_responses_from_templates
                                        (welcome_with_headers.html.erb)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| base_mailer.rb | `actionmailer/test/mailers/base_mailer.rb` | ソース | テスト用メーラークラス定義 |
| base.rb | `actionmailer/lib/action_mailer/base.rb` | ソース | headersメソッドの実装 |
| welcome_with_headers.html.erb | `actionmailer/test/fixtures/base_mailer/welcome_with_headers.html.erb` | テンプレート | メール本文テンプレート（空） |
| base_test.rb | `actionmailer/test/base_test.rb` | テスト | カスタムヘッダー機能テスト |
