# 通知設計書 5-Get-DbaDbMailConfig

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Get-DbaDbMailConfig` コマンドの設計仕様を記述したものである。このコマンドはSQL ServerのDatabase Mailの構成値（最大ファイルサイズ、禁止拡張子など）を取得するための機能を提供する。

### 本通知の処理概要

`Get-DbaDbMailConfig` は、SQL ServerのDatabase Mail構成値を取得するPowerShellコマンドである。MaxFileSize、ProhibitedExtensions、DatabaseMailExeMinLifeTime、LoggingLevelなどのグローバル設定を取得できる。

**業務上の目的・背景**：Database Mailの構成値は、メール送信の動作を制御する重要なグローバル設定である。添付ファイルの最大サイズ制限、セキュリティ上禁止される拡張子、メールエンジンの動作パラメータなどを含む。このコマンドは、組織のメールポリシーへの準拠確認、配信問題のトラブルシューティング、環境間での設定比較に使用される。

**通知の送信タイミング**：このコマンド自体は通知を送信しない。Database Mail構成値を「取得」するための読み取り専用コマンドである。ユーザーが明示的にコマンドを実行したときにのみ動作する。

**通知の受信者**：該当なし（情報取得コマンド）。出力結果はコマンド実行者（通常はDBA）がPowerShellコンソールまたはスクリプト内で受け取る。

**通知内容の概要**：SQL ServerインスタンスごとにConfigurationValueオブジェクトを返す。このオブジェクトには、ComputerName、InstanceName、SqlInstance、Name、Value、Descriptionが含まれる。

**期待されるアクション**：取得した情報をもとに、DBAは設定値の確認、組織ポリシーへの準拠検証、配信制限の確認、他サーバーとの設定比較などを行う。

## 通知種別

該当なし - 本コマンドはDatabase Mail構成値を取得するための情報取得コマンドであり、通知送信機能は持たない。

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 該当なし（情報取得コマンド） |
| 優先度 | 該当なし |
| リトライ | 該当なし |

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

該当なし - このコマンドは情報取得専用であり、通知送信は行わない。

## 通知テンプレート

該当なし - 通知送信機能なし。

### メール通知の場合

該当なし

### 本文テンプレート

該当なし

### 添付ファイル

該当なし

## テンプレート変数

該当なし

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 手動実行 | ユーザーがコマンドを実行 | なし | 明示的なコマンド実行でのみ動作 |
| パイプライン入力 | InputObjectパラメータへのSqlMailオブジェクト | なし | Get-DbaDbMailからのパイプライン連携可能 |

### 送信抑止条件

該当なし（情報取得コマンド）

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンド実行] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDbMailで SqlMailオブジェクト取得]
    B -->|No| D{InputObject指定?}
    C --> E[InputObjectに追加]
    D -->|Yes| E
    D -->|No| F[Stop-Function: No servers to process]
    E --> G{InputObject存在?}
    G -->|No| F
    G -->|Yes| H[foreach: 各mailserverを処理]
    H --> I[ConfigurationValuesコレクション取得]
    I --> J{Nameパラメータ指定?}
    J -->|Yes| K[指定名前でフィルタ]
    J -->|No| L[Add-Member: プロパティ追加]
    K --> L
    L --> M[Select-DefaultView: 既定プロパティ選択]
    M --> N[パイプラインに出力]
    N --> O{次のmailserver?}
    O -->|Yes| H
    O -->|No| P[終了]
    F --> P
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| SMO ConfigurationValue オブジェクト | 構成値を取得 | SQL Server Management Objects経由 |
| msdb.dbo.sysmail_configuration | Database Mail設定値 | SMO経由で間接参照 |

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

#### SMO ConfigurationValue オブジェクト

| 参照項目（プロパティ名） | 用途 | 取得条件 |
|-------------------|------|---------|
| Name | 設定名（MaxFileSize、ProhibitedExtensionsなど） | 常に取得 |
| Value | 設定値 | 常に取得 |
| Description | 設定の説明文 | 常に取得 |

#### 主な構成値

| 設定名 | 説明 | 既定値 |
|-------|------|-------|
| MaxFileSize | 添付ファイルの最大サイズ（バイト） | 1000000 |
| ProhibitedExtensions | 禁止される添付ファイル拡張子 | exe,dll,vbs,js |
| DatabaseMailExeMinLifeTime | DatabaseMailエンジンの最小稼働時間（秒） | 600 |
| LoggingLevel | ログ記録レベル | 2 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| なし | - | 読み取り専用コマンド |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| No servers to process | SqlInstanceもInputObjectも指定なし | Stop-Functionでメッセージ出力後、return |
| 一般的な失敗 | 構成値取得時のエラー | Stop-Functionでメッセージ出力後、次へ継続 |

### リトライ仕様

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

## 配信設定

### レート制限

該当なし（情報取得コマンド）

### 配信時間帯

該当なし

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

- SQL Server への接続には Windows認証、SQL Server認証、Active Directory認証がサポートされる
- SqlCredentialパラメータで代替資格情報を指定可能
- MFAが必要な場合は事前にConnect-DbaInstanceを使用する

## 備考

- SQL Server Management Objects (SMO) を使用して構成値を取得
- 出力オブジェクトはMicrosoft.SqlServer.Management.Smo.Mail.ConfigurationValue型
- Get-DbaDbMailからパイプライン入力をサポート
- Nameパラメータで特定の構成値に限定可能（エイリアス: Config, ConfigName）

---

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

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

### 推奨読解順序

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

ConfigurationValueオブジェクトの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbMailConfig.ps1 | `public/Get-DbaDbMailConfig.ps1` | 行37-56: .OUTPUTSセクションで返却されるオブジェクト型と既定表示プロパティを確認 |

**読解のコツ**: ConfigurationValueオブジェクトはSqlMailの子オブジェクト。Name、Value、Descriptionが既定表示プロパティ。構成名には「MaxFileSize」「ProhibitedExtensions」「DatabaseMailExeMinLifeTime」「LoggingLevel」などがある。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbMailConfig.ps1 | `public/Get-DbaDbMailConfig.ps1` | 行91-100: パラメータ定義。SqlInstance、SqlCredential、Name（エイリアス: Config, ConfigName）、InputObject、EnableException |

**主要処理フロー**:
1. **行102-104**: SqlInstance指定時はGet-DbaDbMailでSqlMailオブジェクト取得
2. **行106-109**: InputObjectがない場合はStop-Functionで終了
3. **行111**: foreachで各mailserverを処理
4. **行113**: $mailserver.ConfigurationValuesで構成値コレクション取得
5. **行115-117**: Nameパラメータによるフィルタリング
6. **行119-121**: Add-MemberでComputerName、InstanceName、SqlInstance追加
7. **行122**: Select-DefaultViewで既定プロパティを選択して出力

#### Step 3: 親コマンドとの連携を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | SqlMailオブジェクトの取得処理 |

**主要処理フロー**:
- **行103**: Get-DbaDbMailを内部呼び出ししてSqlMailオブジェクト取得

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

```
Get-DbaDbMailConfig
    │
    ├─ Get-DbaDbMail (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │             └─ SMO Server接続確立
    │
    ├─ $mailserver.ConfigurationValues (構成値コレクション取得)
    │
    ├─ Where-Object (フィルタリング)
    │      └─ Name パラメータ
    │
    ├─ Add-Member (カスタムプロパティ追加)
    │      ├─ ComputerName
    │      ├─ InstanceName
    │      └─ SqlInstance
    │
    └─ Select-DefaultView (既定表示プロパティ設定)
```

### データフロー図

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

SqlInstance[]        ───▶  Get-DbaDbMail          ───▶  SqlMail オブジェクト
      or                          │
InputObject(SqlMail)              ▼
                          $mailserver.            ───▶  ConfigurationValue
                          ConfigurationValues            コレクション
                                  │
                                  ▼
                          Where-Object フィルタ   ───▶  フィルタ済み構成値
                                  │
                                  ▼
                          Add-Member追加          ───▶  拡張ConfigurationValue
                                  │                      オブジェクト
                                  ▼
                          Select-DefaultView      ───▶  パイプライン出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMailConfig.ps1 | `public/Get-DbaDbMailConfig.ps1` | ソース | メインコマンド実装 |
| Get-DbaDbMailConfig.Tests.ps1 | `tests/Get-DbaDbMailConfig.Tests.ps1` | テスト | Pesterユニットテスト |
| Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | ソース | 親コマンド（SqlMailオブジェクト取得） |
| Copy-DbaDbMail.ps1 | `public/Copy-DbaDbMail.ps1` | ソース | 関連: 構成値のコピー |
