# バッチ設計書 4-Inboxes::FetchImapEmailsJob

## 概要

本ドキュメントは、Chatwootアプリケーションにおける`Inboxes::FetchImapEmailsJob`バッチの設計仕様を記載したものである。

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

このバッチは、個別のメールチャネルからIMAPプロトコルを使用してメールを取得し、Chatwootの会話として処理するジョブである。

**業務上の目的・背景**：顧客からのメール問い合わせを自動的にChatwootの会話として取り込むことで、エージェントがメールクライアントを使用せずにChatwoot上で一元的にカスタマーサポートを行えるようにする。このジョブはメールプロバイダー（一般IMAP、Microsoft、Google）に応じた適切な取得サービスを使用し、メールを取得・処理する。

**バッチの実行タイミング**：親ジョブ（FetchImapEmailInboxesJob）から呼び出される子ジョブとして実行される。親ジョブは毎分実行されるため、条件を満たすチャネルは毎分処理対象となる。

**主要な処理内容**：
1. チャネルのIMAP有効状態と再認証要否を確認
2. インボックス単位でRedisミューテックスロックを取得
3. プロバイダー別のメール取得サービスを呼び出し
4. 取得したメールをImapMailboxで処理し会話として登録
5. 処理完了後にロックを解放

**前後の処理との関連**：Inboxes::FetchImapEmailInboxesJobから呼び出される子ジョブ。取得したメールはImap::ImapMailboxで処理され、会話とメッセージとしてデータベースに保存される。

**影響範囲**：conversations、messages、contact_inboxes、contactsテーブルに新規レコードが作成される可能性がある。

## バッチ種別

メール取込 / データ連携

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 親ジョブから呼び出し（毎分） |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 親ジョブ（FetchImapEmailInboxesJob）からのperform_later |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| IMAP有効 | チャネルでIMAPが有効化されていること |
| 再認証不要 | チャネルの再認証が不要であること |
| ロック取得可能 | インボックス単位のミューテックスロックが取得できること |

### 実行可否判定

`should_fetch_email?`メソッドにより判定：
- `channel.imap_enabled?`がtrueであること
- `channel.reauthorization_required?`がfalseであること

上記を満たさない場合、処理をスキップしてreturnする。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| channel | Channel::Email | Yes | - | メールチャネルオブジェクト |
| interval | Integer | No | 1 | メール検索の期間（日数） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| IMAPサーバー | IMAP | メールプロバイダーのIMAPサーバー |
| channel_email | DB | チャネルのIMAP設定（サーバー、ポート、認証情報） |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| conversations | DB | 新規会話の作成 |
| messages | DB | メールコンテンツからメッセージ作成 |
| contact_inboxes | DB | コンタクトとインボックスの関連付け |
| contacts | DB | 新規コンタクトの作成（必要時） |

### 出力ファイル仕様

ファイル出力なし

## 処理フロー

### 処理シーケンス

```
1. 実行条件チェック
   └─ should_fetch_email?でIMAP有効・再認証不要を確認
   └─ 条件不満足の場合return
2. ミューテックスロックの取得
   └─ EMAIL_MESSAGE_MUTEX（インボックスID単位）でロック取得
   └─ タイムアウト: 5分
   └─ ロック取得失敗時はLockAcquisitionError
3. メール取得サービスの選択・実行
   └─ Microsoftチャネル: Imap::MicrosoftFetchEmailService
   └─ Googleチャネル: Imap::GoogleFetchEmailService
   └─ その他: Imap::FetchEmailService
4. メール処理
   └─ 取得した各メールに対してImap::ImapMailbox.process
   └─ 会話・メッセージとして保存
5. ロック解放
   └─ 処理完了後にロックを自動解放
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B{IMAP有効?}
    B -->|No| C[処理終了]
    B -->|Yes| D{再認証必要?}
    D -->|Yes| C
    D -->|No| E[ミューテックスロック取得]
    E --> F{ロック成功?}
    F -->|No| G[LockAcquisitionError]
    F -->|Yes| H{プロバイダー判定}
    H -->|Microsoft| I[MicrosoftFetchEmailService]
    H -->|Google| J[GoogleFetchEmailService]
    H -->|その他| K[FetchEmailService]
    I --> L[メール取得]
    J --> L
    K --> L
    L --> M[各メールをImapMailboxで処理]
    M --> N[ロック解放]
    N --> O[バッチ終了]
    G --> C
```

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

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

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| メッセージ重複チェック | messages | SELECT | source_idによる既存メッセージ確認 |
| 会話作成 | conversations | INSERT | 新規会話の作成 |
| メッセージ作成 | messages | INSERT | メールコンテンツの保存 |
| コンタクト作成・更新 | contacts | INSERT/UPDATE | 送信者情報の保存 |
| コンタクトインボックス作成 | contact_inboxes | INSERT | コンタクトとインボックスの関連付け |

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

#### messages

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | source_id | inbox_id AND source_id = message_id | 重複チェック |
| INSERT | content, source_id, inbox_id, conversation_id, etc. | メールコンテンツ | 新規メッセージ |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | LockAcquisitionError | ミューテックスロック取得失敗 | ログ出力、次回実行でリトライ |
| - | IMAP認証エラー | IMAP認証失敗 | ログ出力、再認証フラグ設定 |
| - | OAuth2::Error | OAuthトークン失敗 | authorization_error!を呼び出し |
| - | Net::IMAP例外 | IMAP通信エラー | ログ出力 |
| - | StandardError | その他予期しないエラー | ChatwootExceptionTrackerで記録 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Sidekiqのデフォルト設定に依存 |
| リトライ間隔 | Sidekiqのデフォルト設定に依存 |
| リトライ対象エラー | LockAcquisitionError以外の例外 |

### 障害時対応

- IMAP認証エラー時：チャネルに再認証フラグが設定され、以降の取得がスキップされる。ユーザーが再認証を行うまで処理停止。
- OAuth2エラー時：`authorization_error!`メソッドで再認証フラグを設定
- その他エラー時：ChatwootExceptionTrackerで例外を記録し、ログに詳細を出力

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | ImapMailbox内の処理単位 |
| コミットタイミング | メール単位で処理・コミット |
| ロールバック条件 | 個別メール処理中の例外発生時 |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | インボックスあたり数件〜数十件/回 |
| 目標処理時間 | 5分以内（ロックタイムアウト） |
| メモリ使用量上限 | メールサイズに依存 |

## 排他制御

- `EMAIL_MESSAGE_MUTEX`（形式: `EMAIL_CHANNEL_LOCK::{inbox_id}`）によるインボックス単位の分散ロック
- ロックタイムアウト: 5分
- MutexApplicationJobの`with_lock`メソッドを使用
- 同一インボックスの同時処理を防止

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 情報ログ | ロック取得成功時 | `Acquired lock for: {key} on attempt {n}` |
| 情報ログ | メール取得時 | プロバイダー、メールID、sequence ID |
| 警告ログ | ロック取得失敗時 | `Failed to acquire lock on attempt {n}` |
| エラーログ | 認証エラー時 | `Authorization error for email channel - {inbox_id}` |
| エラーログ | 通信エラー時 | `Error for email channel - {inbox_id}` |
| エラーログ | メール処理失敗時 | ドロップしたメールの情報（from, message_id） |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ジョブ失敗 | 連続失敗 | Sidekiq監視 |
| 再認証フラグ設定 | 発生時 | 運用監視 |
| ロック取得失敗 | 頻発時 | 運用監視 |

## 備考

- MutexApplicationJobを継承しており、分散ロック機能を使用
- プロバイダー別に異なるメール取得サービスを使用（Microsoft、Google、一般IMAP）
- メール取得の期間はintervalパラメータで指定可能（デフォルト1日）
- メールの重複取得は`email_already_present?`メソッドで防止（source_idによるチェック）
- バッチサイズ10でメッセージIDを取得し、メモリ効率を考慮
