# 通知設計書 3-BaseMailer#html_only

## 概要

本ドキュメントは、Rails ActionMailerフレームワークにおけるBaseMailer#html_onlyメソッドによるHTMLフォーマットのみのメール通知の設計を記述する。

### 本通知の処理概要

BaseMailer#html_onlyは、HTMLフォーマットのみでメールを送信するためのテスト用メーラーメソッドである。テキストパートを含まず、HTMLパートのみで構成されるメールを生成することで、ActionMailerのシングルパートHTMLメール機能を実証する。

**業務上の目的・背景**：リッチなビジュアルデザインを必要とするマーケティングメール、ニュースレター、HTMLフォーマットでの情報提供が求められる通知において使用される。テキストフォールバックを提供せず、HTMLレンダリング機能を持つメールクライアントのみをターゲットとする場合に適している。本実装はテスト用であり、Content-Typeがtext/htmlに正しく設定されることの検証を主目的とする。

**通知の送信タイミング**：メーラーメソッドが呼び出された時点で送信される。

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

**通知内容の概要**：HTMLテンプレート（html_only.html.erb）の内容`<h1>Testing</h1>`が本文として送信される。Content-Typeはtext/htmlとなる。

**期待されるアクション**：受信者はHTMLフォーマットで整形されたメールを閲覧する。テスト用途では、シングルパートHTMLメールのContent-Type設定が正しく動作することを確認する。

## 通知種別

メール

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | jose@test.plataformatec.com |
| 送信元名称 | （未設定） |
| 件名 | Html only（I18nデフォルト - アクション名をhumanize） |
| 形式 | text/html |

### 本文テンプレート

```html
<h1>Testing</h1>
```

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API呼び出し | `BaseMailer.html_only` メソッド実行 | なし（常に送信） | メーラーメソッドの直接呼び出し |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BaseMailer.html_only 呼び出し] --> B[MessageDelivery オブジェクト生成]
    B --> C[deliver_now/deliver_later 呼び出し]
    C --> D[メーラーインスタンス生成]
    D --> E[html_only メソッド実行]
    E --> F[mail hash メソッド呼び出し]
    F --> G[html_only.html.erb テンプレート検索]
    G --> H[HTMLテンプレートのみ発見]
    H --> I[Content-Type: text/html 設定]
    I --> J[Mail::Message 生成]
    J --> K[配信処理]
    K --> L[終了]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| テンプレート未検出 | html_only.html.erbが存在しない場合 | ActionView::MissingTemplate例外 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- HTMLメールはXSS攻撃のリスクがあるため、動的コンテンツを含める場合はエスケープ処理が必要
- テスト用メーラーのため、本番環境での使用は非推奨

## 備考

- テキストパートを含まないため、テキストのみ表示可能なメールクライアントでは内容が表示されない可能性がある
- マルチパートメール（text/plain + text/html）が推奨される場合は、implicit_multipartまたはexplicit_multipartを使用すべき
- ActionMailerはテンプレートの拡張子（.html.erb）からContent-Typeを自動判定する

---

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

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

### 推奨読解順序

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

シングルパートメールの構造とContent-Type決定ロジックを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | base.rb | `actionmailer/lib/action_mailer/base.rb` | L901-926: set_content_typeメソッド - Content-Type決定ロジック |

**読解のコツ**: set_content_typeメソッドは添付ファイルの有無、マルチパートかどうかを判定し、適切なContent-Typeを返す。シングルパートの場合はテンプレートのMIMEタイプがそのまま使用される。

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

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

**主要処理フロー**:
1. **L40**: `mail(hash)` - オプションのhashパラメータを渡してmailメソッド呼び出し

#### Step 3: テンプレート検索とContent-Type設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | base.rb | `actionmailer/lib/action_mailer/base.rb` | L992-1003: collect_responses_from_templatesメソッド |
| 3-2 | base.rb | `actionmailer/lib/action_mailer/base.rb` | L1005-1012: each_templateメソッド |

**主要処理フロー**:
- **L996-1001**: テンプレートを検索し、各テンプレートのフォーマットからMIMEタイプを決定
- **L1000**: `Mime[format].to_s` - フォーマットからMIMEタイプ文字列を取得

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | base_test.rb | `actionmailer/test/base_test.rb` | L85-89: シングルパートメールのContent-Typeテスト |

**主要処理フロー**:
- **L86-87**: `mail = BaseMailer.html_only` + `assert_equal("text/html", mail.mime_type)` - HTMLのみのメールでContent-Typeがtext/htmlになることを検証

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

```
BaseMailer.html_only(hash)
    │
    ├─ ActionMailer::Base.method_missing
    │      └─ MessageDelivery.new(self, :html_only, hash)
    │
    └─ MessageDelivery#deliver_now
           │
           ├─ processed_mailer
           │      └─ BaseMailer.new.process(:html_only, hash)
           │             │
           │             └─ BaseMailer#html_only(hash)
           │                    └─ mail(hash)
           │                           │
           │                           ├─ collect_responses_from_templates
           │                           │      └─ each_template("base_mailer", "html_only")
           │                           │             └─ html_only.html.erb 発見
           │                           │                    └─ format: :html
           │                           │
           │                           └─ set_content_type
           │                                  └─ "text/html" (単一テンプレート)
           │
           └─ message.deliver
```

### データフロー図

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

html_only.html.erb     ───▶ lookup_context.find_all        ───▶ Template オブジェクト
  (テンプレート)              │                                  (format: :html)
                              ▼
                        ───▶ collect_responses_from_templates
                              │
                              ├─ render(template: template)
                              │    └─ "<h1>Testing</h1>"
                              │
                              └─ Mime[:html].to_s
                                   └─ "text/html"
                                          │
                                          ▼
                        ───▶ set_content_type              ───▶ Mail::Message
                              │                                  Content-Type: text/html
                              └─ 添付なし & 非マルチパート
                                   └─ テンプレートのMIMEタイプ使用
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| base_mailer.rb | `actionmailer/test/mailers/base_mailer.rb` | ソース | テスト用メーラークラス定義 |
| base.rb | `actionmailer/lib/action_mailer/base.rb` | ソース | Content-Type設定ロジック |
| html_only.html.erb | `actionmailer/test/fixtures/base_mailer/html_only.html.erb` | テンプレート | HTMLメール本文テンプレート |
| base_test.rb | `actionmailer/test/base_test.rb` | テスト | Content-Type検証テスト |
