# 通知設計書 12-Remove-DbaDbMailProfile

## 概要

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

### 本通知の処理概要

Remove-DbaDbMailProfileは、SQL ServerインスタンスのMSDBデータベースに構成されたDatabase Mailプロファイルを永続的に削除するコマンドです。プロファイルはメールアカウントをグループ化するコンテナであり、削除されると関連する通知設定が無効化されます。

**業務上の目的・背景**：Database Mailプロファイルは、SQL Server Agentのジョブ通知やアラート通知で使用されます。セキュリティ強化のための不要プロファイル削除、アプリケーション廃止に伴うクリーンアップ、誤設定されたプロファイルの除去など、運用管理において本コマンドは重要な役割を果たします。

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

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

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

**期待されるアクション**：管理者は出力結果を確認し、全てのプロファイルが正常に削除されたことを確認します。失敗した場合はエラーメッセージを基に原因を調査します。プロファイルを使用しているジョブやアラートがある場合は事前に通知設定を変更する必要があります。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

- SqlInstanceパラメータ指定時：Get-DbaDbMailProfileを内部呼び出しして対象プロファイルを取得
- InputObjectパラメータ指定時：パイプラインから渡されたMailProfileオブジェクトを直接処理
- Profileパラメータ：特定のプロファイル名を指定して削除対象を限定（ワイルドカード対応）
- ExcludeProfileパラメータ：削除対象から除外するプロファイル名を指定（ワイルドカード対応）

## 通知テンプレート

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

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

### 本文テンプレート

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

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

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

### 添付ファイル

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

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

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

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンド実行開始] --> B{SqlInstance指定?}
    B -->|Yes| C[Get-DbaDbMailProfile呼び出し]
    B -->|No| D[InputObjectを配列に追加]
    C --> E[dbMailProfiles配列に格納]
    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_profile | メールプロファイル情報の取得 | SMOを通じて間接参照 |
| msdb.dbo.sysmail_profileaccount | プロファイルとアカウントの関連 | プロファイルに紐づくアカウント |

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

#### msdb.dbo.sysmail_profile

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| profile_id | プロファイル識別 | SMOオブジェクト経由 |
| name | プロファイル名表示 | 削除対象の特定 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| msdb.dbo.sysmail_profile | DELETE | プロファイルの削除 |
| msdb.dbo.sysmail_profileaccount | DELETE | アカウントとの関連付け削除（カスケード） |
| msdb.dbo.sysmail_principalprofile | DELETE | プリンシパルとの関連付け削除（カスケード） |

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

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 接続失敗 | SqlInstanceに接続不可 | Connect-DbaInstance内でエラー処理 |
| プロファイル不存在 | 指定プロファイルが見つからない | Get-DbaDbMailProfileが空を返す |
| Drop失敗 | SMO Drop()メソッド失敗 | Stop-Functionでエラーメッセージ出力 |
| 権限不足 | sysadmin権限なし | SMOからエラー返却 |
| 使用中エラー | プロファイルがジョブ等で使用中 | 依存オブジェクトの確認を促す |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- Get-DbaDbMailProfileからパイプラインで直接削除する場合、endブロックで処理することで「Collection was modified」エラーを回避
- EnableExceptionスイッチにより、スクリプト内でのtry/catchエラーハンドリングが可能
- プロファイルはアカウントのコンテナであり、プロファイル削除後もアカウント自体は残存する

---

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

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

### 推奨読解順序

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

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

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

**読解のコツ**: `[Microsoft.SqlServer.Management.Smo.Mail.MailProfile[]]`型がSMOのメールプロファイルオブジェクトであることを理解する。

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

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

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

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

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Remove-DbaDbMailProfile.ps1 | `public/Remove-DbaDbMailProfile.ps1` | 101-103行目: beginブロック - 配列初期化 |
| 3-2 | Remove-DbaDbMailProfile.ps1 | `public/Remove-DbaDbMailProfile.ps1` | 105-114行目: processブロック - プロファイル収集 |
| 3-3 | Remove-DbaDbMailProfile.ps1 | `public/Remove-DbaDbMailProfile.ps1` | 116-140行目: endブロック - 削除実行 |

**主要処理フロー**:
- **102行目**: `$dbMailProfiles = @( )` - 削除対象を格納する配列を初期化
- **106-110行目**: SqlInstance指定時、Get-DbaDbMailProfileを呼び出して対象取得
- **111-113行目**: パイプライン入力時、InputObjectを配列に追加
- **118-139行目**: foreachループで各プロファイルを削除

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

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

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

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

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

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

### データフロー図

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

SqlInstance ────────┐
SqlCredential ──────┼──▶ Get-DbaDbMailProfile ──┐
Profile ────────────┤                           │
ExcludeProfile ─────┘                           ▼
                                          dbMailProfiles配列
InputObject ────────────────────────────────────┘
                                                │
                                                ▼
                                    foreach ループ (endブロック)
                                                │
                                                ▼
                                    ShouldProcess確認
                                                │
                                                ▼
                                    MailProfile.Drop()
                                                │
                                                ▼
                                        PSCustomObject
                                    (ComputerName, InstanceName,
                                     SqlInstance, Name,
                                     Status, IsRemoved)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Remove-DbaDbMailProfile.ps1 | `public/Remove-DbaDbMailProfile.ps1` | ソース | メインコマンド実装 |
| Get-DbaDbMailProfile.ps1 | `public/Get-DbaDbMailProfile.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-DbaDbMailProfile内で使用） |
