# バッチ設計書 50-action_mailbox:install

## 概要

本ドキュメントは、Action Mailboxとその依存関係をインストールするRakeタスク `action_mailbox:install` の設計仕様を定義する。

### 本バッチの処理概要

`action_mailbox:install` タスクは、Action Mailbox（インバウンドメール処理機能）をRailsアプリケーションに導入するためのセットアップを実行するインストーラタスクである。必要なファイル、マイグレーション、環境設定を自動的に追加する。

**業務上の目的・背景**：Action Mailboxは、Rails 6.0で導入されたインバウンドメール処理フレームワークである。受信したメールをルーティングし、適切なMailboxクラスで処理することで、メールをアプリケーションの入力として活用できる。カスタマーサポートのチケット作成、メールによるコメント投稿、自動応答システムなど、メールを起点としたワークフローを構築できる。本タスクは、この機能を使用するために必要な初期設定を自動化する。

**バッチの実行タイミング**：手動実行が主体であり、以下のような場面で使用される。
- Railsアプリケーションへの Action Mailbox 初回導入時
- メール受信機能が必要な新規プロジェクト

**主要な処理内容**：
1. Rails::Command.invokeを使用してaction_mailbox:installジェネレータを呼び出し
2. app/mailboxes/application_mailbox.rbをコピー
3. config/environments/production.rbにingress設定のコメントを追加
4. railties:install:migrations FROM=active_storage,action_mailboxでマイグレーションをコピー
5. Active StorageとAction Mailboxのマイグレーションをdb/migrateに追加

**前後の処理との関連**：本タスクは Active Storage のマイグレーションも含めてインストールする。Action Mailbox は Active Storage に依存しているため、両方のマイグレーションが必要。インストール後は `db:migrate` を実行してマイグレーションを適用し、ingress設定を行う必要がある。

**影響範囲**：アプリケーションのファイルシステムに以下の変更を加える。
- app/mailboxes配下にapplication_mailbox.rbを追加
- config/environments/production.rbにコメントを追加
- db/migrateにマイグレーションファイルを追加

## バッチ種別

インストール / セットアップ

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 1回（初回導入時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動（bin/rails action_mailbox:install） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Rails環境 | Rails 6.0以上のアプリケーションであること |
| データベース | Active Recordが使用可能であること |

### 実行可否判定

Railsアプリケーションであれば実行可能。既にインストール済みの場合でも実行できるが、ファイルの上書きが発生する可能性がある。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| なし | - | - | - | 入力パラメータは不要 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| action_mailbox gemのテンプレート | Ruby | コピー元のファイル群 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | 処理進捗メッセージ |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| app/mailboxes/application_mailbox.rb | ベースMailboxクラス |
| db/migrate/*_create_action_mailbox_tables.rb | マイグレーションファイル |
| db/migrate/*_create_active_storage_tables.rb | Active Storageマイグレーション |
| config/environments/production.rb | ingress設定コメント追加 |

## 処理フロー

### 処理シーケンス

```
1. Rails::Command.invoke でジェネレータ呼び出し
   └─ generate action_mailbox:install を実行
2. ApplicationMailbox ファイル作成
   └─ app/mailboxes/application_mailbox.rb をコピー
3. production 環境設定追加
   └─ config/environments/production.rb に ingress 設定コメントを追加
4. マイグレーションコピー
   └─ railties:install:migrations FROM=active_storage,action_mailbox を実行
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[Rails::Command.invoke 実行]
    B --> C[ApplicationMailbox ファイル作成]
    C --> D[production 環境設定追加]
    D --> E[railties:install:migrations 実行]
    E --> F[Active Storage マイグレーションコピー]
    F --> G[Action Mailbox マイグレーションコピー]
    G --> H{同名ファイル存在？}
    H -->|Yes| I[スキップメッセージ出力]
    H -->|No| J[コピー完了メッセージ出力]
    I --> K[バッチ終了]
    J --> K
```

## データベース操作仕様

### 操作別データベース影響一覧

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| マイグレーション適用後 | action_mailbox_inbound_emails | CREATE TABLE | 受信メール格納テーブル |
| マイグレーション適用後 | active_storage_blobs | CREATE TABLE | Active Storage Blob |
| マイグレーション適用後 | active_storage_attachments | CREATE TABLE | Active Storage 添付 |

### テーブル別操作詳細

本タスク自体はマイグレーションファイルのコピーのみ。`db:migrate` 実行後にテーブルが作成される。

#### action_mailbox_inbound_emails テーブル

| カラム名 | 型 | 説明 |
|---------|-----|------|
| id | bigint | 主キー |
| status | integer | 処理ステータス（pending, processing, delivered, failed, bounced） |
| message_id | string | RFC 2822 Message-ID |
| message_checksum | string | メッセージのチェックサム |
| created_at | datetime | 作成日時 |
| updated_at | datetime | 更新日時 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ファイル書き込みエラー | 権限不足 | ディレクトリの権限を確認 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | なし |
| リトライ対象エラー | なし |

### 障害時対応

エラー発生時は、出力されたエラーメッセージを確認し、手動でファイルをコピーするか、環境を整備して再実行する。

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | なし（ファイル操作のみ） |
| コミットタイミング | なし |
| ロールバック条件 | なし |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回 |
| 目標処理時間 | 数秒以内 |
| メモリ使用量上限 | 最小限 |

## 排他制御

同時実行は推奨されない。ファイル競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 標準出力 | ファイルコピー時 | "Copying application_mailbox.rb to app/mailboxes" |
| 標準出力 | マイグレーションコピー時 | "Copied migration xxx from action_mailbox" |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| - | - | - |

本タスクは1回限りの実行が主であり、監視は不要。

## 備考

- インストール後は `bin/rails db:migrate` を実行してマイグレーションを適用する
- ingress設定（:relay, :mailgun, :mandrill, :postmark, :sendgrid）を選択して設定する必要がある
- production環境に追加されるコメントは `config.action_mailbox.ingress = :relay` の例
- メール受信のルーティングは ApplicationMailbox.routing で設定
- 個別のMailboxクラスは `bin/rails generate mailbox` で生成可能
- Action MailboxはActive Storageに依存するため、両方のマイグレーションが必要
