# 通知設計書 11-Email from other user

## 概要

本ドキュメントは、Wikipedia iOSアプリケーションにおける「Email from other user（他のユーザーからのメール）」通知の設計を定義する。この通知は、Wikipedia内部のメール機能を介して他のユーザーからメールが送信された際に、受信者に対してプッシュ通知およびアプリ内通知として配信される。

### 本通知の処理概要

本通知は、Wikipediaユーザー間のコミュニケーションを促進するためのメール通知機能を提供する。

**業務上の目的・背景**：Wikipediaでは、ユーザー間の直接的なコミュニケーション手段として「メール送信機能（Special:EmailUser）」が用意されている。この機能により、トークページを介さずにプライベートな連絡を取ることが可能となる。本通知は、受信者が新着メールを見逃さないようにするための重要なアラート機能である。

**通知の送信タイミング**：他のユーザーがWikipedia内の「Special:EmailUser」機能を使用してメールを送信した時点で、MediaWiki Echo拡張機能がイベントを生成し、通知がトリガーされる。

**通知の受信者**：メールの宛先に指定されたユーザーが受信者となる。受信者は自身の設定でメール通知を有効にしている必要がある。

**通知内容の概要**：送信者のユーザー名と「New email（新着メール）」という件名が表示される。メールの本文は通知には含まれず、ユーザーはメールを確認するためにWikipediaにアクセスする必要がある。

**期待されるアクション**：受信者は通知を確認後、送信者のユーザーページにアクセスし、必要に応じて返信や対応を行うことが期待される。

## 通知種別

- プッシュ通知（iOS Push Notification）
- アプリ内通知（Notifications Center）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（MediaWiki Echo APIからのプル型） |
| 優先度 | passive（0.5） |
| リトライ | APIフェッチ時に自動リトライあり |

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

MediaWiki Echo拡張機能がメール送信イベントを検知し、受信者のユーザーアカウントに対して通知を生成する。iOSアプリは、ログイン中のユーザーに紐づく通知をEcho APIから定期的に取得し、ローカルデータベースに保存・表示する。

## 通知テンプレート

### プッシュ通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Wikipediaアプリ |
| タイトル | Email from other user |
| 本文 | pushContentTextに基づく動的テキスト |
| 割り込みレベル | passive |
| 関連スコア | 0.5 |

### 本文テンプレート

```
New email from {agentName}
```

### アプリ内通知表示

| 項目 | 内容 |
|-----|------|
| ヘッダーテキスト | "Email from other user" |
| サブヘッダーテキスト | "From {agentName}" |
| ボディテキスト | messageHeader（メッセージヘッダー） |
| フッターテキスト | なし |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| agentName | 送信者のユーザー名 | RemoteNotification.agentName | Yes |
| messageHeader | メッセージヘッダー | RemoteNotification.messageHeader | No |
| date | 通知日時 | RemoteNotification.date | Yes |
| wiki | プロジェクト識別子 | RemoteNotification.wiki | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| API | Echo API通知取得 | ユーザーがログイン中 | アプリがアクティブになった際、またはバックグラウンドリフレッシュ時にAPIから通知を取得 |
| プッシュ | APNs経由のプッシュ通知 | デバイス登録済み | MediaWikiサーバーからAPNs経由でプッシュ通知を受信 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| フィルター設定 | ユーザーがemail通知タイプをフィルターで除外している場合 |
| 未認証状態 | ユーザーがログインしていない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[MediaWikiでemailイベント発生] --> B[Echo APIに通知登録]
    B --> C{プッシュ通知対応?}
    C -->|Yes| D[APNs経由でプッシュ送信]
    C -->|No| E[アプリ内通知のみ]
    D --> F[NotificationService Extension処理]
    F --> G[通知コンテンツ生成]
    G --> H[ユーザーに表示]
    E --> I[アプリ起動時にAPI取得]
    I --> J[CoreDataに保存]
    J --> K[Notifications Centerに表示]
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| RemoteNotification | 通知データの保存・取得 | Core Data Entity |
| PushNotificationsCache | プッシュ通知キャッシュ | SharedContainerCache |

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

#### RemoteNotification

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| categoryString | 通知カテゴリ判定 | "emailuser" |
| typeString | 通知タイプ判定 | "emailuser" |
| agentName | 送信者名表示 | - |
| messageHeader | メッセージヘッダー表示 | - |
| messageLinks | アクションURL取得 | - |
| isRead | 既読状態 | - |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| RemoteNotification | INSERT/UPDATE | 新規通知の保存・既読状態の更新 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| API取得失敗 | ネットワークエラー | リトライ処理、フォールバックテキスト表示 |
| 認証エラー | トークン期限切れ | 再認証フローへ遷移 |
| データベースエラー | Core Data保存失敗 | エラーログ出力、次回同期時に再取得 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 自動（OperationQueue管理） |
| リトライ間隔 | 30秒のデッドライン制御 |
| リトライ対象エラー | ネットワークエラー、一時的なサーバーエラー |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| リフレッシュ間隔 | 30秒以上 |
| バッチ取得 | APIから一括取得 |

### 配信時間帯

制限なし（24時間配信）

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

- メール本文は通知には含まれず、メタデータのみが表示される
- 通知データはCore Dataに暗号化されて保存される
- APNs通信はTLS暗号化
- ユーザー認証状態の検証が必須

## 備考

- categoryString: "emailuser"
- typeString: "emailuser"
- 画像アイコン: "notifications-type-email"
- 背景色: theme.colors.link（デフォルト）

---

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

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

### 推奨読解順序

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

通知のデータモデルとタイプ定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | 14行目: `.emailFromOtherUser`タイプの定義、158-159行目: 優先度(.passive, 0.5)の設定 |
| 1-2 | RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | 8行目: `emailFromOtherUser`フィルタータイプ、117-118行目: カテゴリ文字列"emailuser"の定義 |
| 1-3 | RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | 38-39行目: category/typeからの型変換ロジック |

**読解のコツ**: Swiftのenum定義とswitch文によるパターンマッチングに注目。

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

プッシュ通知受信とアプリ内表示の起点を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | 19-92行目: プッシュ通知受信時の処理フロー、70-73行目: 優先度設定 |
| 2-2 | RemoteNotificationsController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsController.swift` | 125-163行目: loadNotifications関数、通知取得のメイン処理 |

**主要処理フロー**:
1. **19行目**: didReceive - プッシュ通知受信
2. **40行目**: getUnreadPushNotifications - API呼び出し
3. **70-73行目**: 優先度・割り込みレベル設定

#### Step 3: ViewModel層を理解する

通知の表示ロジックを把握。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | 47-48行目: "New email"サブヘッダーテキスト、82-83行目: messageHeaderの取得 |
| 3-2 | NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | 18-19行目: emailFromOtherUserのサブヘッダー処理、59-61行目: フッターテキストなし |
| 3-3 | NotificationsCenterDetailViewModel+ActionExtensions.swift | `Wikipedia/Code/NotificationsCenterDetailViewModel+ActionExtensions.swift` | 38-41行目: プライマリアクション（送信者ユーザーページ）、101-102行目: セカンダリアクション |

**主要処理フロー**:
- **47-48行目**: verboseTitle - "New email"
- **82-83行目**: message - messageHeader表示

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

```
NotificationService.didReceive (Push受信)
    │
    ├─ RemoteNotificationsAPIController.getUnreadPushNotifications
    │      └─ APIからJSON取得
    │
    └─ NotificationServiceHelper.determineNotificationsToDisplayAndCache
           └─ pushContentText生成

RemoteNotificationsController.loadNotifications (アプリ内)
    │
    ├─ RemoteNotificationsOperationsController.loadNotifications
    │      └─ RemoteNotificationsAPIController
    │
    └─ RemoteNotificationsModelController
           └─ Core Data保存

NotificationsCenterViewController
    │
    └─ NotificationsCenterCellViewModel
           ├─ NotificationsCenterCommonViewModel (テキスト生成)
           └─ sheetActions (アクション生成)
```

### データフロー図

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

MediaWiki Echo API ──▶ NotificationService Extension ──▶ iOS Push通知表示
        │
        └──────────▶ RemoteNotificationsController ──▶ CoreData保存
                            │
                            └──▶ NotificationsCenterViewModel ──▶ UI表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| RemoteNotificationType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationType.swift` | ソース | 通知タイプ定義 |
| RemoteNotificationFilterType.swift | `WMF Framework/Remote Notifications/Model/RemoteNotificationFilterType.swift` | ソース | フィルタータイプ定義 |
| RemoteNotification+CoreDataClass.swift | `WMF Framework/Remote Notifications/Model/RemoteNotification+CoreDataClass.swift` | ソース | Core Dataエンティティ |
| NotificationService.swift | `NotificationServiceExtension/NotificationService.swift` | ソース | プッシュ通知処理 |
| RemoteNotificationsController.swift | `WMF Framework/Remote Notifications/RemoteNotificationsController.swift` | ソース | 通知コントローラー |
| NotificationsCenterCommonViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCommonViewModel+TextExtensions.swift` | ソース | テキスト生成 |
| NotificationsCenterCellViewModel+TextExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+TextExtensions.swift` | ソース | セルテキスト生成 |
| NotificationsCenterDetailViewModel+ActionExtensions.swift | `Wikipedia/Code/NotificationsCenterDetailViewModel+ActionExtensions.swift` | ソース | アクション定義 |
| NotificationsCenterCellViewModel+SheetActionExtensions.swift | `Wikipedia/Code/NotificationsCenterCellViewModel+SheetActionExtensions.swift` | ソース | シートアクション定義 |
| CommonStrings.swift | `WMF Framework/CommonStrings.swift` | ソース | ローカライズ文字列 |
