# 通知設計書 3-Get-DbaDbMailAccount

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `Get-DbaDbMailAccount` コマンドの設計仕様を記述したものである。このコマンドはSQL ServerインスタンスからDatabase Mailアカウント設定（メールアドレス、表示名、SMTPサーバー設定など）を取得するための機能を提供する。

### 本通知の処理概要

`Get-DbaDbMailAccount` は、SQL ServerのDatabase Mailアカウント設定を取得するPowerShellコマンドである。アカウントにはメールアドレス、表示名、SMTP サーバー設定、認証情報などが含まれており、DBAはこれらの情報を使用してメール配信の設定監査やトラブルシューティングを行える。

**業務上の目的・背景**：Database Mailアカウントは、SQL Serverがメール送信に使用するSMTP設定の実体である。メールサーバーの接続情報、送信者アドレス、認証情報などを含む。このコマンドは、複数サーバー間でのメールアカウント設定の監査、配信問題の診断、移行時の設定確認を支援する。SMTPサーバーへの接続問題やメール配信エラーのトラブルシューティングに不可欠である。

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

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

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

**期待されるアクション**：取得した情報をもとに、DBAはメールアカウント設定の確認、SMTP設定の検証、配信問題の診断、他サーバーへの設定移行計画の策定などを行う。

## 通知種別

該当なし - 本コマンドは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[Accountsコレクション取得]
    I --> J{Accountパラメータ指定?}
    J -->|Yes| K[指定アカウントでフィルタ]
    J -->|No| L{ExcludeAccount指定?}
    K --> L
    L -->|Yes| M[除外アカウントを除去]
    L -->|No| N[Add-Member: プロパティ追加]
    M --> N
    N --> O[Select-DefaultView: 既定プロパティ選択]
    O --> P[パイプラインに出力]
    P --> Q{次のmailserver?}
    Q -->|Yes| H
    Q -->|No| R[終了]
    F --> R
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| SMO SqlMailAccount オブジェクト | アカウント設定を取得 | SQL Server Management Objects経由 |
| msdb.dbo.sysmail_account | アカウント情報 | SMO経由で間接参照 |
| msdb.dbo.sysmail_server | SMTPサーバー情報 | SMO経由で間接参照 |

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

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

| 参照項目（プロパティ名） | 用途 | 取得条件 |
|-------------------|------|---------|
| ID | アカウント識別子 | 常に取得 |
| Name | アカウント名 | 常に取得 |
| DisplayName | 表示名（Fromフィールドに使用） | 常に取得 |
| Description | 説明文 | 常に取得 |
| EmailAddress | 送信者メールアドレス | 常に取得 |
| ReplyToAddress | 返信先アドレス | 常に取得 |
| IsBusyAccount | ビジー状態フラグ | 常に取得 |
| MailServers | 関連SMTPサーバーコレクション | 常に取得 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

該当なし

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

- SQL Server への接続には Windows認証、SQL Server認証、Active Directory認証がサポートされる
- SqlCredentialパラメータで代替資格情報を指定可能
- MFAが必要な場合は事前にConnect-DbaInstanceを使用する
- 出力にはSMTPサーバー認証情報が含まれる可能性があり、取り扱いに注意が必要

## 備考

- SQL Server Management Objects (SMO) を使用してアカウント設定を取得
- 出力オブジェクトはMicrosoft.SqlServer.Management.Smo.Mail.SqlMailAccount型
- Get-DbaDbMailからパイプライン入力をサポート
- Accountパラメータで特定のアカウントに限定可能
- ExcludeAccountパラメータで特定のアカウントを除外可能
- MailServersプロパティから各アカウントに紐づくSMTPサーバー情報にアクセス可能

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: SqlMailAccountオブジェクトはSqlMailの子オブジェクト。ID、Name、DisplayName、Description、EmailAddress、ReplyToAddress、IsBusyAccount、MailServersが既定表示プロパティ。MailServersコレクションでSMTPサーバー設定にアクセス可能。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaDbMailAccount.ps1 | `public/Get-DbaDbMailAccount.ps1` | 行99-108: パラメータ定義。SqlInstance、SqlCredential、Account、ExcludeAccount、InputObject、EnableException |

**主要処理フロー**:
1. **行110-112**: SqlInstance指定時はGet-DbaDbMailでSqlMailオブジェクト取得
2. **行114-117**: InputObjectがない場合はStop-Functionで終了
3. **行119**: foreachで各mailserverを処理
4. **行121**: $mailserver.Accountsでアカウントコレクション取得
5. **行123-129**: AccountパラメータとExcludeAccountパラメータによるフィルタリング
6. **行131-133**: Add-MemberでComputerName、InstanceName、SqlInstance追加
7. **行134**: Select-DefaultViewで既定プロパティを選択して出力

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

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

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

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

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

### データフロー図

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

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

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMailAccount.ps1 | `public/Get-DbaDbMailAccount.ps1` | ソース | メインコマンド実装 |
| Get-DbaDbMailAccount.Tests.ps1 | `tests/Get-DbaDbMailAccount.Tests.ps1` | テスト | Pesterユニットテスト |
| Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | ソース | 親コマンド（SqlMailオブジェクト取得） |
| Get-DbaDbMailServer.ps1 | `public/Get-DbaDbMailServer.ps1` | ソース | 関連: SMTPサーバー詳細取得 |
| New-DbaDbMailAccount.ps1 | `public/New-DbaDbMailAccount.ps1` | ソース | 関連: アカウント作成 |
| Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | ソース | 関連: アカウント削除 |
