# 機能設計書 262-Get-DbaDbMailHistory

## 概要

本ドキュメントは、SQL ServerのDatabase Mailメッセージ履歴を取得するGet-DbaDbMailHistoryコマンドレットの機能設計を記述する。

### 本機能の処理概要

Get-DbaDbMailHistoryは、SQL Serverのmsdb.dbo.sysmail_allitemsテーブルから包括的なDatabase Mail履歴を取得するPowerShellコマンドレットである。配信ステータス、受信者、件名、タイムスタンプなどの詳細情報を含むメール送信履歴を取得でき、メール配信問題のトラブルシューティング、コンプライアンス監査、Database Mailパフォーマンス監視に活用される。

**業務上の目的・背景**：Database Mailは、SQL Serverからの自動通知、アラート、レポート配信に不可欠な機能である。本コマンドは、メール配信の成功・失敗状況の確認、配信問題の原因調査、コンプライアンス要件に基づくメール送信ログの監査といった業務課題を解決する。特に障害発生時には、特定期間や特定ステータスでのフィルタリングにより効率的な調査が可能となる。

**機能の利用シーン**：
- メール配信障害発生時のトラブルシューティング
- 特定期間のメール送信状況レポート作成
- 失敗（Failed）ステータスのメール一覧取得
- コンプライアンス監査用のメール送信記録取得
- 未送信（Unsent）やリトライ中（Retrying）メールの確認

**主要な処理内容**：
1. SQL Serverインスタンスへの接続
2. msdb.dbo.sysmail_allitemsとsysmail_profileのJOINクエリ実行
3. Since（日時）およびStatus（配信状態）によるフィルタリング
4. 結果をPSCustomObjectとしてパイプライン出力

**関連システム・外部連携**：msdbデータベースのDatabase Mailシステムテーブル（sysmail_allitems、sysmail_profile）に直接T-SQLクエリを発行する。SMOではなくT-SQLを使用して効率的なデータ取得を実現。

**権限による制御**：msdbデータベースへの読み取りアクセス権限が必要。sysadminサーバーロールまたはDatabaseMailUserRoleデータベースロールのメンバーシップが必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 52 | データベースメール | 補助機能 | メール履歴の取得 |

## 機能種別

データ取得（SELECT）/ ログ・履歴参照

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 接続先SQL Serverインスタンス | パイプライン入力対応 |
| SqlCredential | PSCredential | No | 代替認証用資格情報 | Windows/SQL認証対応 |
| Since | DateTime | No | 指定日時以降のメールのみ取得 | 有効なDateTime値 |
| Status | string | No | 配信ステータスでフィルタ | Unsent/Sent/Failed/Retrying |
| EnableException | switch | No | 例外を直接スローするかどうか | - |

### 入力データソース

- SqlInstance: ユーザー指定（パイプライン入力対応）
- Since/Status: オプションのフィルタ条件

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverホスト名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全修飾インスタンス名 |
| MailItemId | int | メールアイテムの一意識別子 |
| ProfileId | int | Database Mailプロファイルの識別子 |
| Profile | string | Database Mailプロファイル名 |
| Recipients | string | 主受信者のメールアドレス |
| CopyRecipients | string | CC受信者のメールアドレス |
| BlindCopyRecipients | string | BCC受信者のメールアドレス |
| Subject | string | メールの件名 |
| Body | string | メール本文（Select-Object *で取得可能） |
| BodyFormat | string | 本文フォーマット（HTML/TEXT） |
| Importance | string | 重要度（Low/Normal/High） |
| Sensitivity | string | 機密度（Normal/Personal/Private/Confidential） |
| FileAttachments | string | 添付ファイル |
| AttachmentEncoding | string | 添付ファイルのエンコーディング |
| SendRequestDate | DateTime | 送信リクエスト日時 |
| SendRequestUser | string | 送信リクエストユーザー |
| SentStatus | string | 配信ステータス（Unsent/Sent/Failed/Retrying） |
| SentDate | DateTime | 実際の送信日時 |

### 出力先

パイプライン出力（PSCustomObject型）

## 処理フロー

### 処理シーケンス

```
1. 入力パラメータの検証
   └─ SqlInstanceが必要

2. 各インスタンスへの接続
   └─ Connect-DbaInstanceで接続確立

3. SQLクエリの構築
   └─ 基本SELECT文の作成
   └─ WHERE句の動的生成（Since、Status指定時）

4. クエリ実行
   └─ server.Query()メソッドでT-SQL実行

5. 結果の出力
   └─ Select-DefaultViewで既定表示プロパティを設定
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[foreachインスタンスループ]
    B --> C[Connect-DbaInstance]
    C --> D{接続成功?}
    D -->|No| E[Stop-Function継続]
    D -->|Yes| F[基本SQL構築]
    F --> G{Since/Status指定?}
    G -->|Yes| H[WHERE句追加]
    G -->|No| I[クエリ実行]
    H --> I
    I --> J[Select-DefaultView]
    J --> K[結果出力]
    K --> L{次のインスタンス?}
    L -->|Yes| B
    L -->|No| M[終了]
    E --> L
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 日時フィルタ | send_request_dateがSince以降のレコードを取得 | Sinceパラメータ指定時 |
| BR-002 | ステータスフィルタ | sent_statusが指定値と一致するレコードを取得 | Statusパラメータ指定時 |
| BR-003 | ステータス正規化 | 小文字のステータスをPascalCaseに変換して出力 | 常時 |

### 計算ロジック

特になし

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 履歴取得 | msdb.dbo.sysmail_allitems | SELECT | メール履歴の読み取り |
| プロファイル結合 | msdb.dbo.sysmail_profile | SELECT | プロファイル名取得用JOIN |

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

#### msdb.dbo.sysmail_allitems (alias: a)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | mailitem_id, profile_id, recipients, copy_recipients, blind_copy_recipients, subject, body, body_format, importance, sensitivity, file_attachments, attachment_encoding, query, execute_query_database, attach_query_result_as_file, query_result_header, query_result_width, query_result_separator, exclude_query_output, append_query_error, send_request_date, send_request_user, sent_account_id, sent_status, sent_date, last_mod_date, last_mod_user | WHERE send_request_date >= @Since AND/OR sent_status IN (@Status) | オプションフィルタ |

#### msdb.dbo.sysmail_profile (alias: p)

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| SELECT | name | JOIN ON a.profile_id = p.profile_id | プロファイル名取得 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | ConnectionError | SQL Serverに接続できない | 接続設定・資格情報を確認 |
| - | クエリエラー | SQLクエリ実行失敗 | 権限・Database Mail設定を確認 |

### リトライ仕様

なし（即時エラー終了、-Continue指定で次インスタンスへ継続）

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

読み取り専用操作のため、明示的なトランザクション制御なし

## パフォーマンス要件

- 大量の履歴データがある場合、Sinceパラメータで期間を限定することを推奨
- Statusフィルタとの組み合わせで効率的なデータ取得が可能

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

- 資格情報はPSCredentialオブジェクトで安全に受け渡し
- Windows認証、SQL認証、AD Password認証、AD Integrated認証をサポート
- メール本文には機密情報が含まれる可能性があるため、出力の取り扱いに注意

## 備考

- 既定表示ではBodyは表示されない（Select-Object *で取得可能）
- 日時はISO 8601形式（yyyy-MM-ddTHH:mm:ss）でSQLに渡される

---

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

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

### 推奨読解順序

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

出力されるPSCustomObjectのプロパティ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbMailHistory.ps1 | `public/Get-DbaDbMailHistory.ps1` | .OUTPUTSセクション（35-72行目）で出力プロパティを確認 |

**読解のコツ**: 既定表示プロパティとSelect-Object *で取得できる追加プロパティの違いを把握する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbMailHistory.ps1 | `public/Get-DbaDbMailHistory.ps1` | パラメータ定義（103-112行目）とprocessブロック（113行目） |

**主要処理フロー**:
1. **104-105行目**: SqlInstanceパラメータ（パイプライン入力対応）
2. **108-110行目**: Since、Statusフィルタパラメータ
3. **114-120行目**: Connect-DbaInstanceでの接続処理

#### Step 3: SQLクエリ構築ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbMailHistory.ps1 | `public/Get-DbaDbMailHistory.ps1` | 動的SQL構築処理（122-177行目） |

**主要処理フロー**:
- **122-160行目**: 基本SELECTクエリ（sysmail_allitemsとsysmail_profileのJOIN）
- **162-177行目**: Since/Status指定時のWHERE句動的生成
- **165-167行目**: Since日時のISO 8601形式変換
- **169-172行目**: StatusのIN句生成

#### Step 4: クエリ実行と出力処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Get-DbaDbMailHistory.ps1 | `public/Get-DbaDbMailHistory.ps1` | クエリ実行と結果整形（179-186行目） |

**主要処理フロー**:
- **179行目**: Write-MessageでデバッグログにSQL出力
- **182行目**: server.Query()メソッドでT-SQL実行
- **182行目**: Select-DefaultViewで既定表示プロパティを設定

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

```
Get-DbaDbMailHistory
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server接続
    │
    ├─ SQLクエリ構築
    │      ├─ 基本SELECT（sysmail_allitems JOIN sysmail_profile）
    │      └─ WHERE句動的生成（Since/Status）
    │
    ├─ server.Query()
    │      └─ T-SQL実行
    │
    └─ Select-DefaultView
           └─ 出力整形
```

### データフロー図

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

SqlInstance ────────▶ Connect-DbaInstance
                              │
                              ▼
Since ─────────────▶ WHERE句構築 ──────────▶ SQL実行
                              │
Status ────────────▶         │
                              ▼
                     msdb.dbo.sysmail_allitems
                              │
                              ▼
                     msdb.dbo.sysmail_profile (JOIN)
                              │
                              ▼
                     Select-DefaultView
                              │
                              ▼
                     [PSCustomObject]
                     - ComputerName
                     - Profile
                     - Recipients
                     - Subject
                     - SentStatus
                     - SentDate
                     など
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMailHistory.ps1 | `public/Get-DbaDbMailHistory.ps1` | ソース | メイン処理ロジック |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続処理 |
