# 機能設計書 259-Get-DbaDbMail

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける`Get-DbaDbMail`コマンドレットの機能設計書です。SQL ServerインスタンスからDatabase Mail構成（プロファイル、アカウント、設定）を取得します。

### 本機能の処理概要

`Get-DbaDbMail`コマンドは、1つ以上のSQL Serverインスタンスから完全なDatabase Mail構成を取得します。メールプロファイル、SMTPアカウント、構成値、プロパティなどが含まれます。

**業務上の目的・背景**：Database Mailは、SQL Serverからの自動通知、アラート、レポート送信に広く使用されています。複数のサーバーにわたるメール設定を監査したり、トラブルシューティングしたり、コンプライアンス目的でドキュメント化する必要がある場合、各サーバーの設定を迅速に確認できることが重要です。本機能は、Database Mail構成全体を一度に取得し、監査やトラブルシューティングを効率化します。

**機能の利用シーン**：
- 複数サーバーのDatabase Mail設定監査
- メール配信問題のトラブルシューティング
- 構成ドキュメント作成
- 環境間の設定比較
- コンプライアンスレポート作成

**主要な処理内容**：
1. 指定されたSQL Serverインスタンスへの接続
2. SMO経由でMailオブジェクトを取得
3. インスタンス情報をプロパティとして追加
4. Select-DefaultViewで表示プロパティを制限して出力

**関連システム・外部連携**：SQL ServerのDatabase Mail機能（SMO経由）

**権限による制御**：Database Mail構成の読み取り権限が必要です。通常、publicロールまたはmsdbへのアクセス権限で十分です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能はPowerShellコマンドレットであり、関連するGUI画面はありません |

## 機能種別

情報取得 / 監査

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | Yes | 取得対象のSQL Serverインスタンス | パイプライン入力可能 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| EnableException | switch | No | 例外を有効にする | - |

### 入力データソース

- コマンドラインからの直接入力
- パイプライン経由での入力

## 出力仕様

### 出力データ

出力型: `Microsoft.SqlServer.Management.Smo.Mail.SqlMail`（カスタムプロパティ追加）

**デフォルト表示プロパティ（Select-DefaultView）：**

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| Profiles | SqlMailProfileCollection | Database Mailプロファイルコレクション |
| Accounts | SqlMailAccountCollection | Database Mailアカウントコレクション |
| ConfigurationValues | SqlMailConfigurationValueCollection | Database Mail構成値コレクション |
| Properties | PropertyCollection | 追加プロパティコレクション |

**追加プロパティ（Select-Object * で表示）：**

SMO SqlMailオブジェクトの全プロパティにアクセス可能

### 出力先

- PowerShellパイプライン（SqlMailオブジェクト）
- 関連コマンドへのパイプ（Get-DbaDbMailProfile、Get-DbaDbMailAccountなど）

## 処理フロー

### 処理シーケンス

```
1. process ブロック
   └─ 各SqlInstanceに対してループ処理
       ├─ Connect-DbaInstance
       ├─ 接続エラー時はStop-FunctionでContinue
       ├─ $server.Mailオブジェクト取得
       ├─ Add-Memberでカスタムプロパティ追加
       │   ├─ ComputerName
       │   ├─ InstanceName
       │   └─ SqlInstance
       └─ Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstanceループ}
    B -->|次のインスタンス| C[Connect-DbaInstance]
    C -->|成功| D[$server.Mail取得]
    C -->|失敗| E[Stop-Function/Continue]
    E --> B
    D --> F[Add-Member ComputerName]
    F --> G[Add-Member InstanceName]
    G --> H[Add-Member SqlInstance]
    H --> I[Select-DefaultView出力]
    I --> B
    B -->|完了| J[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | SMO利用 | SMO経由でDatabase Mailオブジェクトを取得 | 常に適用 |
| BR-002 | カスタムプロパティ | インスタンス識別用のプロパティを追加 | 常に適用 |

### 関連コマンドとのパイプライン連携

| コマンド | 用途 |
|---------|-----|
| Get-DbaDbMailProfile | プロファイル詳細の取得 |
| Get-DbaDbMailAccount | アカウント詳細の取得 |
| Get-DbaDbMailConfig | 構成値詳細の取得 |
| Get-DbaDbMailServer | SMTPサーバー詳細の取得 |

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|-----|---------|------|
| Mail取得 | msdb | SELECT | SMO経由でDatabase Mail構成を読み取り |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Server接続失敗 | Stop-FunctionでContinue |
| GeneralError | 一般エラー | Mail取得失敗 | Stop-FunctionでContinue |

### リトライ仕様

本機能にはリトライ機能はありません。

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

本機能は読み取り専用であり、トランザクション管理は不要です。

## パフォーマンス要件

- 各インスタンスからのメタデータ取得は通常1秒以内で完了
- 大量のプロファイル/アカウントがある場合でも効率的に取得

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

- 読み取り専用操作
- Database Mail構成へのアクセス権限が必要
- 機密情報（パスワード）は取得されない

## 備考

- 出力オブジェクトは他のGet-DbaDbMail*コマンドにパイプ可能
- Select-Object * で全プロパティにアクセス可能

---

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

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

### 推奨読解順序

#### Step 1: パラメータと全体構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | 68-74行目：パラメータ定義 |

**主要処理フロー**:
1. **70行目**: SqlInstanceは必須でパイプライン入力可能
2. **71行目**: SqlCredentialはオプション
3. **72行目**: EnableExceptionはスイッチ

#### Step 2: processブロックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | 75-94行目：メイン処理 |

**主要処理フロー**:
- **78-79行目**: Connect-DbaInstance
- **84-85行目**: try-catchでエラーハンドリング
- **85行目**: $server.Mailオブジェクト取得
- **86-88行目**: Add-Memberでカスタムプロパティ追加
- **89行目**: Select-DefaultViewで出力

**読解のコツ**:
- `Add-Member -Force`は既存プロパティを上書き
- `Select-DefaultView`はデフォルト表示を制限するdbatools独自関数

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

```
Get-DbaDbMail
    │
    ├─ Connect-DbaInstance
    │      └─ SQL Server SMOオブジェクト取得
    │
    ├─ $server.Mail
    │      └─ SqlMailオブジェクト取得
    │
    ├─ Add-Member
    │      └─ カスタムプロパティ追加
    │
    └─ Select-DefaultView
           └─ デフォルト表示プロパティ制限
```

### データフロー図

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

SqlInstance     ───▶ Connect-DbaInstance
                            │
SqlCredential   ───────────┘
                            │
                            ▼
                     $server.Mail取得
                            │
                            ▼
                     Add-Member (3プロパティ追加)
                            │
                            ▼
                     Select-DefaultView ───▶ SqlMailオブジェクト
                                                    │
                                                    ├──▶ Get-DbaDbMailProfile
                                                    ├──▶ Get-DbaDbMailAccount
                                                    ├──▶ Get-DbaDbMailConfig
                                                    └──▶ Get-DbaDbMailServer
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | ソース | メイン関数定義 |
| Get-DbaDbMailProfile.ps1 | `public/Get-DbaDbMailProfile.ps1` | ソース | プロファイル取得 |
| Get-DbaDbMailAccount.ps1 | `public/Get-DbaDbMailAccount.ps1` | ソース | アカウント取得 |
| Get-DbaDbMailConfig.ps1 | `public/Get-DbaDbMailConfig.ps1` | ソース | 構成値取得 |
| Get-DbaDbMailServer.ps1 | `public/Get-DbaDbMailServer.ps1` | ソース | サーバー取得 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
