# 機能設計書 260-Get-DbaDbMailAccount

## 概要

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

### 本機能の処理概要

`Get-DbaDbMailAccount`コマンドは、SQL ServerインスタンスのDatabase Mailアカウント構成（メールアドレス、表示名、SMTPサーバー設定、認証詳細など）を取得します。

**業務上の目的・背景**：Database Mailアカウントは、SQL Serverがメールを送信するために使用するSMTP構成を定義します。複数のサーバーにわたるメール設定を監査したり、メール配信問題をトラブルシューティングしたり、コンプライアンス目的でドキュメント化する必要がある場合に、アカウント構成を迅速に確認できることが重要です。本機能は、Database Mailアカウントの詳細情報を取得し、監査やトラブルシューティングを効率化します。

**機能の利用シーン**：
- Database Mailアカウントの構成監査
- メール配信問題のトラブルシューティング
- SMTPサーバー設定の確認
- 構成ドキュメント作成
- 環境間の設定比較

**主要な処理内容**：
1. SqlInstanceまたはInputObject（Get-DbaDbMailの出力）からMailオブジェクトを取得
2. アカウントのフィルタリング（Account/ExcludeAccountパラメータ）
3. インスタンス情報をプロパティとして追加
4. Select-DefaultViewで表示プロパティを制限して出力

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

**権限による制御**：Database Mail構成の読み取り権限が必要です。

## 関連画面

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

## 機能種別

情報取得 / 監査

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | 取得対象のSQL Serverインスタンス | - |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Account | string[] | No | 取得対象のアカウント名（完全一致） | - |
| ExcludeAccount | string[] | No | 除外するアカウント名 | - |
| InputObject | SqlMail[] | No | Get-DbaDbMailからのパイプライン入力 | ValueFromPipeline |
| EnableException | switch | No | 例外を有効にする | - |

### 入力データソース

- コマンドラインからの直接入力（SqlInstance）
- パイプライン経由での入力（Get-DbaDbMailの出力）

## 出力仕様

### 出力データ

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

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

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | SQL Serverのコンピュータ名 |
| InstanceName | string | SQL Serverインスタンス名 |
| SqlInstance | string | 完全なSQL Serverインスタンス名 |
| ID | int | Database Mailアカウントの一意識別子 |
| Name | string | Database Mailアカウント名 |
| DisplayName | string | メール送信時のFrom表示名 |
| Description | string | アカウントの説明テキスト |
| EmailAddress | string | 送信者メールアドレス |
| ReplyToAddress | string | 返信先メールアドレス |
| IsBusyAccount | bool | アカウントがメッセージ送信中かどうか |
| MailServers | SqlMailServerCollection | SMTPサーバーコレクション |

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

- Account: アカウント所有者情報
- AccountType: アカウントタイプ
- CreateDate: 作成日時
- Urn: オブジェクトのURN
- Parent: 親SqlMailオブジェクト
- Properties: プロパティコレクション
- State: オブジェクト状態
- Uid: 一意識別子

### 出力先

- PowerShellパイプライン（SqlMailAccountオブジェクト）

## 処理フロー

### 処理シーケンス

```
1. process ブロック
   ├─ SqlInstance指定の場合
   │   └─ Get-DbaDbMailでInputObjectに追加
   ├─ InputObject未設定の場合
   │   └─ Stop-FunctionでReturn
   └─ 各InputObject（mailserver）に対してループ処理
       ├─ アカウントコレクション取得
       ├─ Accountパラメータでフィルタリング
       ├─ ExcludeAccountパラメータでフィルタリング
       ├─ Add-Memberでカスタムプロパティ追加
       └─ Select-DefaultViewで出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDbMailでInputObject取得]
    B -->|No| D{InputObject存在?}
    C --> D
    D -->|No| E[Stop-Function/Return]
    D -->|Yes| F{InputObjectループ}
    F -->|次| G[Accounts取得]
    G --> H{Account指定?}
    H -->|Yes| I[Accountでフィルタ]
    H -->|No| J{ExcludeAccount指定?}
    I --> J
    J -->|Yes| K[ExcludeAccountでフィルタ]
    J -->|No| L[Add-Member]
    K --> L
    L --> M[Select-DefaultView出力]
    M --> F
    F -->|完了| N[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | パイプライン連携 | SqlInstance指定時はGet-DbaDbMailで変換 | SqlInstance指定時 |
| BR-002 | Accountフィルタ | Account指定時は完全一致でフィルタ | Account指定時 |
| BR-003 | ExcludeAccountフィルタ | ExcludeAccount指定時は除外 | ExcludeAccount指定時 |

### フィルタリング優先順位

1. Account指定によるインクルードフィルタ
2. ExcludeAccount指定によるエクスクルードフィルタ

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

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

| 操作 | 対象 | 操作種別 | 概要 |
|-----|-----|---------|------|
| アカウント取得 | msdb.dbo.sysmail_account | SELECT | SMO経由でアカウント情報を読み取り |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| NoServers | 入力なしエラー | SqlInstanceもInputObjectも未指定 | Stop-FunctionでReturn |
| GeneralError | 一般エラー | 取得処理中のエラー | Stop-FunctionでContinue |

### リトライ仕様

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

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

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

## パフォーマンス要件

- 各インスタンスからのメタデータ取得は通常1秒以内で完了
- フィルタリングはメモリ内で実行

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

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

## 備考

- Get-DbaDbMailからのパイプライン入力をサポート
- Select-Object * で全プロパティにアクセス可能

---

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

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

### 推奨読解順序

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

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

**主要処理フロー**:
1. **101行目**: SqlInstanceはオプション
2. **103-104行目**: Account/ExcludeAccountでフィルタリング
3. **105-106行目**: InputObjectはパイプライン入力

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

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

**主要処理フロー**:
- **110-112行目**: SqlInstance指定時のGet-DbaDbMail呼び出し
- **114-117行目**: InputObject未設定時のエラー処理
- **119-138行目**: 各mailserverに対するループ処理

#### Step 3: フィルタリングと出力を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaDbMailAccount.ps1 | `public/Get-DbaDbMailAccount.ps1` | 121-134行目：フィルタと出力 |

**主要処理フロー**:
- **121行目**: $mailserver.Accountsでアカウントコレクション取得
- **123-125行目**: Accountパラメータでフィルタ
- **127-129行目**: ExcludeAccountパラメータでフィルタ
- **131-133行目**: Add-Memberでカスタムプロパティ追加
- **134行目**: Select-DefaultViewで出力

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

```
Get-DbaDbMailAccount
    │
    ├─ Get-DbaDbMail (SqlInstance指定時)
    │      └─ Connect-DbaInstance
    │             └─ $server.Mail取得
    │
    ├─ $mailserver.Accounts
    │      └─ SqlMailAccountCollection取得
    │
    ├─ Where-Object (フィルタリング)
    │
    ├─ Add-Member
    │      └─ カスタムプロパティ追加
    │
    └─ Select-DefaultView
           └─ デフォルト表示プロパティ制限
```

### データフロー図

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

SqlInstance     ───▶ Get-DbaDbMail ───┐
                                      │
InputObject     ─────────────────────▶├──▶ $mailserver.Accounts
                                      │
Account         ─────────────────────▶├──▶ Where-Object (Include)
                                      │
ExcludeAccount  ─────────────────────▶├──▶ Where-Object (Exclude)
                                      │
                                      ▼
                               Add-Member
                                      │
                                      ▼
                               Select-DefaultView ───▶ SqlMailAccountオブジェクト
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaDbMailAccount.ps1 | `public/Get-DbaDbMailAccount.ps1` | ソース | メイン関数定義 |
| Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | ソース | Database Mail取得（InputObjectソース） |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
| Stop-Function.ps1 | `internal/functions/flowcontrol/Stop-Function.ps1` | ソース | エラーハンドリング |
