# 通知設計書 11-Remove-DbaDbMailAccount

## 概要

本ドキュメントは、SQL Serverインスタンスからデータベースメールアカウントを削除するdbatools PowerShellコマンド「Remove-DbaDbMailAccount」の設計仕様を記載します。

### 本通知の処理概要

Remove-DbaDbMailAccountは、SQL ServerインスタンスのMSDBデータベースに構成されたDatabase Mailアカウントを永続的に削除するコマンドです。

**業務上の目的・背景**：企業のIT環境では、アプリケーションの廃止、メールシステムの移行、セキュリティポリシーの変更などに伴い、不要になったメールアカウントを削除する必要があります。本コマンドは、複数のSQL Serverインスタンスにまたがるメールアカウントの一括削除や、パイプライン処理による選択的な削除を可能にし、運用効率を向上させます。

**通知の送信タイミング**：本コマンド自体は「通知を送信する」機能ではなく、「通知インフラ（Database Mailアカウント）を管理する」機能です。管理者がコマンドを実行した時点で即座にアカウント削除処理が実行されます。

**通知の受信者**：本コマンドの実行結果はコマンド実行者（DBA、システム管理者）に返されます。削除されたアカウント情報はPSCustomObjectとして出力されます。

**通知内容の概要**：削除処理の結果として、ComputerName、InstanceName、SqlInstance、Name（アカウント名）、Status（処理結果）、IsRemoved（削除成功フラグ）が返されます。

**期待されるアクション**：管理者は出力結果を確認し、全てのアカウントが正常に削除されたことを確認します。失敗した場合はエラーメッセージを基に原因を調査し、必要に応じて再実行します。

## 通知種別

PowerShellコンソール出力 / パイプライン出力（PSCustomObject）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コマンド実行と同時に結果出力） |
| 優先度 | 高（ConfirmImpact = 'High'） |
| リトライ | 無（失敗時はエラーメッセージ出力） |

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

- SqlInstanceパラメータ指定時：Get-DbaDbMailAccountを内部呼び出しして対象アカウントを取得
- InputObjectパラメータ指定時：パイプラインから渡されたMailAccountオブジェクトを直接処理
- Accountパラメータ：特定のアカウント名を指定して削除対象を限定
- ExcludeAccountパラメータ：削除対象から除外するアカウント名を指定

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 出力形式 | PSCustomObject |
| 確認プロンプト | ShouldProcess による確認（-Confirm:$false で抑制可能） |

### 本文テンプレート

```
確認プロンプト:
"Removing the database mail account {AccountName} on {SqlInstanceName}"

成功時出力:
ComputerName : {ComputerName}
InstanceName : {InstanceName}
SqlInstance  : {SqlInstance}
Name         : {AccountName}
Status       : Dropped
IsRemoved    : True

失敗時出力:
ComputerName : {ComputerName}
InstanceName : {InstanceName}
SqlInstance  : {SqlInstance}
Name         : {AccountName}
Status       : {ErrorMessage}
IsRemoved    : False
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| なし | - | - | 本コマンドは添付ファイルを出力しない |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ComputerName | SQL Serverのコンピュータ名 | $dbMailAccount.Parent.Parent.ComputerName | Yes |
| InstanceName | SQL Serverのインスタンス名 | $dbMailAccount.Parent.Parent.ServiceName | Yes |
| SqlInstance | 完全修飾インスタンス名 | $dbMailAccount.Parent.Parent.DomainInstanceName | Yes |
| Name | 削除対象のアカウント名 | $dbMailAccount.Name | Yes |
| Status | 処理結果ステータス | "Dropped" または エラーメッセージ | Yes |
| IsRemoved | 削除成功フラグ | $true / $false | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | Remove-DbaDbMailAccount実行 | 削除対象アカウントが存在 | 指定されたアカウントの削除処理を実行 |
| パイプライン入力 | Get-DbaDbMailAccountからのパイプ | InputObjectに有効なオブジェクト | パイプラインから受け取ったアカウントを削除 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| -WhatIf指定時 | 実際の削除は行わず、処理内容のみ表示 |
| ShouldProcess拒否 | ユーザーが確認プロンプトで拒否した場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンド実行開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDbMailAccount呼び出し]
    B -->|No| D[InputObjectを配列に追加]
    C --> E[dbMailAccounts配列に格納]
    D --> E
    E --> F[endブロック: アカウント削除ループ]
    F --> G{ShouldProcess確認}
    G -->|承認| H[出力オブジェクト初期化]
    G -->|拒否| I[次のアカウントへ]
    H --> J[Drop実行]
    J --> K{成功?}
    K -->|Yes| L[Status=Dropped, IsRemoved=True]
    K -->|No| M[Stop-Function呼び出し]
    M --> N[Status=ErrorMessage, IsRemoved=False]
    L --> O[結果出力]
    N --> O
    O --> P{次のアカウント?}
    P -->|Yes| F
    P -->|No| Q[終了]
    I --> P
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| msdb.dbo.sysmail_account | メールアカウント情報の取得 | SMOを通じて間接参照 |
| msdb.dbo.sysmail_server | SMTPサーバー設定 | アカウントに関連付けられた設定 |

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

#### msdb.dbo.sysmail_account

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| account_id | アカウント識別 | SMOオブジェクト経由 |
| name | アカウント名表示 | 削除対象の特定 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| msdb.dbo.sysmail_account | DELETE | アカウントの削除 |
| msdb.dbo.sysmail_server | DELETE | 関連するサーバー設定の削除（カスケード） |
| msdb.dbo.sysmail_profileaccount | DELETE | プロファイルとの関連付け削除（カスケード） |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| なし | - | - | 本コマンドは送信ログを記録しない |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 接続失敗 | SqlInstanceに接続不可 | Connect-DbaInstance内でエラー処理 |
| アカウント不存在 | 指定アカウントが見つからない | Get-DbaDbMailAccountが空を返す |
| Drop失敗 | SMO Drop()メソッド失敗 | Stop-Functionでエラーメッセージ出力 |
| 権限不足 | sysadmin権限なし | SMOからエラー返却 |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | なし |
| 1日あたり上限 | なし |

### 配信時間帯

制限なし（任意のタイミングで実行可能）

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

- sysadmin権限またはmsdbデータベースへの適切な権限が必要
- SqlCredentialパラメータによりSQL Server認証、Windows認証、AD認証をサポート
- 削除操作は永続的であり、復元不可能（事前のバックアップを推奨）
- ConfirmImpact = 'High'により、デフォルトで確認プロンプトを表示

## 備考

- Get-DbaDbMailAccountからパイプラインで直接削除する場合、endブロックで処理することで「Collection was modified」エラーを回避
- EnableExceptionスイッチにより、スクリプト内でのtry/catchエラーハンドリングが可能

---

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

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

### 推奨読解順序

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

まず、処理対象となるMailAccountオブジェクトの構造を理解することが重要です。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | 95行目: InputObjectパラメータの型定義を確認 |

**読解のコツ**: `[Microsoft.SqlServer.Management.Smo.Mail.MailAccount[]]`型がSMOのメールアカウントオブジェクトであることを理解する。

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

処理の起点となるパラメータセットと初期化処理を確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | 84-98行目: CmdletBindingとパラメータ定義 |

**主要処理フロー**:
1. **84行目**: `[CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')]` - 高影響度の確認処理を有効化
2. **86-87行目**: NonPipelineパラメータセット - SqlInstance指定時の処理
3. **94-95行目**: Pipelineパラメータセット - パイプライン入力時の処理

#### Step 3: 処理ブロック（begin/process/end）を理解する

PowerShellの高度な関数構造に沿った処理フローを追跡します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | 100-102行目: beginブロック - 配列初期化 |
| 3-2 | Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | 104-113行目: processブロック - アカウント収集 |
| 3-3 | Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | 115-139行目: endブロック - 削除実行 |

**主要処理フロー**:
- **101行目**: `$dbMailAccounts = @( )` - 削除対象を格納する配列を初期化
- **105-109行目**: SqlInstance指定時、Get-DbaDbMailAccountを呼び出して対象取得
- **110-112行目**: パイプライン入力時、InputObjectを配列に追加
- **117-138行目**: foreachループで各アカウントを削除

#### Step 4: SMOを使用した削除処理を理解する

実際の削除処理とエラーハンドリングを確認します。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | 127-135行目: try/catchによる削除処理 |

**主要処理フロー**:
- **118行目**: `$PSCmdlet.ShouldProcess()` - 確認プロンプト処理
- **128行目**: `$dbMailAccount.Drop()` - SMOメソッドによる削除実行
- **132行目**: `Stop-Function` - dbatools標準のエラー処理

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

```
Remove-DbaDbMailAccount (エントリーポイント)
    |
    +-- [beginブロック]
    |       └── 配列初期化
    |
    +-- [processブロック]
    |       ├── Get-DbaDbMailAccount (SqlInstance指定時)
    |       └── InputObject追加 (パイプライン時)
    |
    └── [endブロック]
            └── foreach ($dbMailAccount)
                    ├── ShouldProcess確認
                    ├── PSCustomObject作成
                    ├── $dbMailAccount.Drop()
                    ├── Stop-Function (エラー時)
                    └── Get-ErrorMessage (エラーメッセージ取得)
```

### データフロー図

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

SqlInstance ────────┐
SqlCredential ──────┼──▶ Get-DbaDbMailAccount ──┐
Account ────────────┤                           │
ExcludeAccount ─────┘                           ▼
                                          dbMailAccounts配列
InputObject ────────────────────────────────────┘
                                                │
                                                ▼
                                    foreach ループ (endブロック)
                                                │
                                                ▼
                                    ShouldProcess確認
                                                │
                                                ▼
                                    MailAccount.Drop()
                                                │
                                                ▼
                                        PSCustomObject
                                    (ComputerName, InstanceName,
                                     SqlInstance, Name,
                                     Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbMailAccount.ps1 | `public/Remove-DbaDbMailAccount.ps1` | ソース | メインコマンド実装 |
| Get-DbaDbMailAccount.ps1 | `public/Get-DbaDbMailAccount.ps1` | ソース | アカウント取得（内部呼び出し） |
| Stop-Function.ps1 | `private/functions/Stop-Function.ps1` | ソース | エラー処理ユーティリティ |
| Get-ErrorMessage.ps1 | `private/functions/Get-ErrorMessage.ps1` | ソース | エラーメッセージ抽出 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続（Get-DbaDbMailAccount内で使用） |
