# 機能設計書 258-Copy-DbaDbMail

## 概要

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

### 本機能の処理概要

`Copy-DbaDbMail`コマンドは、ソースSQL ServerからDatabase Mail構成全体を読み取り、1つ以上の宛先SQL Serverにコピーします。メールプロファイル、アカウント、SMTPサーバー設定、グローバル構成値などが含まれます。

**業務上の目的・背景**：Database Mailは自動アラート、バックアップ通知、ジョブ失敗レポート、メンテナンス通知などに広く使用されています。新規サーバーのセットアップ、環境間の設定標準化、ハードウェア移行時に、手動でDatabase Mail構成を再現するのは時間がかかり、エラーが発生しやすくなります。本機能は、完全なDatabase Mail構成を効率的に移行し、SMTP認証情報を含む全ての設定を保持します。

**機能の利用シーン**：
- 新規SQL Serverセットアップ時の構成コピー
- DR（災害復旧）環境の構築
- 開発/テスト環境への構成複製
- サーバー移行プロジェクト
- 複数サーバーの構成標準化

**主要な処理内容**：
1. ソースサーバーからDatabase Mail構成を読み取り
2. 構成値（Configuration Values）のコピー
3. メールアカウントのコピー
4. メールプロファイルのコピー
5. メールサーバー設定のコピー（パスワード含む）
6. 宛先でDatabase Mail XPsを有効化（必要な場合）

**関連システム・外部連携**：
- SQL ServerのDatabase Mail機能
- SMTPサーバー設定（暗号化されたパスワードの復号化にDAC接続使用）

**権限による制御**：ソースと宛先の両方でsysadmin権限が必要です。パスワード復号化にはDAC（専用管理者接続）が必要です。

## 関連画面

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

## 機能種別

データ移行 / 構成コピー

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| Source | DbaInstanceParameter | Yes | コピー元SQL Serverインスタンス | - |
| SourceSqlCredential | PSCredential | No | ソースへの認証情報 | - |
| Destination | DbaInstanceParameter[] | Yes | コピー先SQL Serverインスタンス（複数可） | - |
| DestinationSqlCredential | PSCredential | No | 宛先への認証情報 | - |
| Credential | PSCredential | No | Windowsホストへの認証情報（パスワード復号化用） | - |
| Type | string[] | No | コピーするコンポーネントタイプ | ValidateSet: ConfigurationValues, Profiles, Accounts, MailServers |
| ExcludePassword | switch | No | パスワードを除外してコピー | - |
| Force | switch | No | 既存オブジェクトを上書き | - |
| WhatIf | switch | No | 実行内容のプレビュー | SupportsShouldProcess |
| Confirm | switch | No | 実行前確認 | SupportsShouldProcess |
| EnableException | switch | No | 例外を有効にする | - |

### 入力データソース

- ソースSQL ServerのDatabase Mail構成（SMO経由）
- パスワード復号化のためのDAC接続

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| DateTime | DbaDateTime | 移行操作のタイムスタンプ |
| SourceServer | string | ソースSQL Serverインスタンス名 |
| DestinationServer | string | 宛先SQL Serverインスタンス名 |
| Name | string | 移行されたコンポーネント名 |
| Type | string | コンポーネントタイプ（Mail Configuration/Mail Profile/Mail Account/Mail Server） |
| Status | string | 移行結果（Successful/Skipped/Failed） |
| Notes | string | 追加情報（スキップ理由、エラーメッセージなど） |

### 出力先

- PowerShellパイプライン（MigrationObject型のPSCustomObject）
- Select-DefaultViewによりデフォルト表示プロパティが制限

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   ├─ パスワード復号化が必要な場合DAC接続を開く
   │   ├─ ExcludePasswordの場合はDAC不要
   │   └─ 通常の場合はDAC接続でソースに接続
   └─ ソースのMail構成を取得
2. process ブロック
   └─ 各Destinationに対してループ処理
       ├─ Connect-DbaInstance
       ├─ Typeパラメータ指定の場合
       │   ├─ ConfigurationValues → Copy-DbaDbMailConfig
       │   ├─ Profiles → Copy-DbaDbMailProfile
       │   ├─ Accounts → Copy-DbaDatabaseAccount
       │   └─ MailServers → Copy-DbaDbMailServer
       └─ Type未指定の場合（全コピー）
           ├─ Copy-DbaDbMailConfig
           ├─ Copy-DbaDatabaseAccount
           ├─ Copy-DbaDbMailProfile
           ├─ Copy-DbaDbMailServer
           └─ Database Mail XPs有効化チェック
3. end ブロック
   └─ DAC接続が開かれた場合は切断
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{ExcludePassword?}
    B -->|Yes| C[通常接続]
    B -->|No| D[DAC接続]
    C --> E[Mail構成取得]
    D --> E
    E --> F{Destinationループ}
    F -->|次| G[Connect-DbaInstance]
    G --> H{Type指定あり?}
    H -->|Yes| I[指定Typeのみコピー]
    H -->|No| J[全コピー]
    I --> K[結果出力]
    J --> L[Config/Account/Profile/Serverコピー]
    L --> M{DB Mail XPs有効化必要?}
    M -->|Yes| N[Set-DbaSpConfigure]
    M -->|No| O[スキップ]
    N --> K
    O --> K
    K --> F
    F -->|完了| P{DAC開いた?}
    P -->|Yes| Q[Disconnect-DbaInstance]
    P -->|No| R[終了]
    Q --> R
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 最小バージョン | SQL Server 2005（バージョン9）以上が必要 | 接続時 |
| BR-002 | DAC接続 | パスワード復号化にはDAC（専用管理者接続）が必要 | ExcludePassword未指定時 |
| BR-003 | 名前変換 | ソースインスタンス名を宛先インスタンス名に置換 | プロファイル・アカウント名内 |
| BR-004 | 強制上書き | Force指定時のみ既存オブジェクトを削除して再作成 | 宛先に同名オブジェクト存在時 |
| BR-005 | DB Mail XPs連動 | ソースで有効な場合、宛先でも有効化 | Type未指定の全コピー時 |

### 内部関数

| 関数名 | 役割 |
|-------|-----|
| Copy-DbaDbMailConfig | 構成値をコピー |
| Copy-DbaDatabaseAccount | メールアカウントをコピー |
| Copy-DbaDbMailProfile | メールプロファイルをコピー |
| Copy-DbaDbMailServer | メールサーバー設定をコピー |

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| 構成取得 | msdb.dbo.sysmail_* | SELECT | Database Mail設定の読み取り |
| 構成作成 | msdb.dbo.sysmail_* | INSERT | Database Mail設定の作成 |
| 認証情報取得 | sys.credentials | SELECT | メールサーバー認証情報 |
| パスワード復号化 | master | SELECT | DAC経由での復号化 |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| ConnectionError | 接続エラー | SQL Server接続失敗 | Stop-FunctionでContinue/Return |
| ExistingObject | 重複エラー | 同名オブジェクトが存在（Force未指定） | Skipped出力でContinue |
| PasswordError | パスワードエラー | パスワード復号化失敗 | 警告を出力して続行 |

### リトライ仕様

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

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

各コンポーネントの移行は個別に実行されます。1つのコンポーネント移行失敗が他に影響することはありません。

## パフォーマンス要件

- DAC接続は1インスタンスにつき1セッションのみ可能
- 構成コピーは通常数秒で完了
- パスワード復号化にはPowerShell Remotingが必要な場合あり

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

- ソースと宛先でsysadmin権限が必要
- パスワード復号化にDAC接続が必要
- ExcludePasswordオプションで機密情報を除外可能
- 暗号化されたパスワードはソースで復号化されて宛先で再設定

## 備考

- 移行結果はMigrationObject型で出力され、移行監査に使用可能
- Database Mail XPsの有効化状態もソースに合わせて設定される

---

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

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

### 推奨読解順序

#### Step 1: パラメータと初期化を理解する

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

**主要処理フロー**:
1. **113-114行目**: Source/Destination（必須）
2. **120-122行目**: Type（ValidateSet）
3. **123行目**: ExcludePassword

#### Step 2: 内部関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Copy-DbaDbMail.ps1 | `public/Copy-DbaDbMail.ps1` | 129-159行目：Copy-DbaDbMailConfig |
| 2-2 | Copy-DbaDbMail.ps1 | `public/Copy-DbaDbMail.ps1` | 161-227行目：Copy-DbaDatabaseAccount |
| 2-3 | Copy-DbaDbMail.ps1 | `public/Copy-DbaDbMail.ps1` | 229-298行目：Copy-DbaDbMailProfile |
| 2-4 | Copy-DbaDbMail.ps1 | `public/Copy-DbaDbMail.ps1` | 300-385行目：Copy-DbaDbMailServer |

#### Step 3: DAC接続とパスワード復号化を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Copy-DbaDbMail.ps1 | `public/Copy-DbaDbMail.ps1` | 387-416行目：DAC接続ロジック |

**主要処理フロー**:
- **390行目**: ExcludePasswordでDAC要否判定
- **396-404行目**: DAC接続または通常接続の選択

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

```
Copy-DbaDbMail
    │
    ├─ Connect-DbaInstance (DAC or Normal)
    │
    ├─ Copy-DbaDbMailConfig (内部関数)
    │      └─ ConfigurationValues.Script()
    │
    ├─ Copy-DbaDatabaseAccount (内部関数)
    │      └─ Account.Script()
    │
    ├─ Copy-DbaDbMailProfile (内部関数)
    │      └─ Profile.Script()
    │
    ├─ Copy-DbaDbMailServer (内部関数)
    │      ├─ Get-DecryptedObject (パスワード復号化)
    │      └─ MailServer.Script()
    │
    ├─ Get-DbaSpConfigure (DB Mail XPs確認)
    │
    ├─ Set-DbaSpConfigure (DB Mail XPs有効化)
    │
    └─ Disconnect-DbaInstance (DAC切断)
```

### データフロー図

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

Source          ───▶ DAC接続(パスワード復号化用)
                            │
                            ▼
                     Mail構成取得(SMO)
                            │
Destination     ───▶ 宛先接続
                            │
                            ▼
                     ┌─────────────────────────┐
                     │ Copy-DbaDbMailConfig    │
                     │ Copy-DbaDatabaseAccount │
                     │ Copy-DbaDbMailProfile   │───▶ MigrationObject出力
                     │ Copy-DbaDbMailServer    │
                     └─────────────────────────┘
                            │
                            ▼
                     DB Mail XPs有効化
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Copy-DbaDbMail.ps1 | `public/Copy-DbaDbMail.ps1` | ソース | メイン関数定義 |
| Get-DbaDbMail.ps1 | `public/Get-DbaDbMail.ps1` | ソース | Database Mail取得関数 |
| Get-DbaSpConfigure.ps1 | `public/Get-DbaSpConfigure.ps1` | ソース | sp_configure取得 |
| Set-DbaSpConfigure.ps1 | `public/Set-DbaSpConfigure.ps1` | ソース | sp_configure設定 |
| Connect-DbaInstance.ps1 | `public/Connect-DbaInstance.ps1` | ソース | SQL Server接続 |
