# 通知設計書 9-New-DbaDbMailProfile

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける `New-DbaDbMailProfile` コマンドの設計仕様を記述したものである。このコマンドはSQL Serverインスタンスに新しいDatabase Mailプロファイルを作成するための機能を提供する。

### 本通知の処理概要

`New-DbaDbMailProfile` は、SQL ServerのDatabase Mailプロファイルを作成するPowerShellコマンドである。プロファイルはメールアカウントをグループ化するためのコンテナであり、SQL Serverからのメール送信に使用される。作成時に既存のメールアカウントを関連付けることも可能。

**業務上の目的・背景**：Database Mailプロファイルは、SQL Serverがメール送信時に使用するアカウントのグループを定義する。複数のアカウントを優先度付きで設定することで、フェイルオーバー構成が可能になる。このコマンドは、通知システムの構築、アプリケーション別のメールプロファイル分離、環境標準化に使用される。sp_send_dbmailストアドプロシージャはプロファイル経由でメールを送信するため、プロファイルはメール送信の必須要素である。

**通知の送信タイミング**：このコマンドはプロファイル作成時に一度だけ実行される。作成されたプロファイルは後続のメール送信に使用される。

**通知の受信者**：該当なし（設定作成コマンド）。作成されたプロファイルを使用してメール送信が行われた場合、そのメールの受信者はプロファイルに関連付けられたアカウント設定に基づいて決定される。

**通知内容の概要**：作成されたMailProfileオブジェクトを返す。このオブジェクトには、ComputerName、InstanceName、SqlInstance、Id、Name、Description、IsBusyProfileが含まれる。

**期待されるアクション**：プロファイル作成後、DBAはアカウントの追加関連付け、sp_send_dbmailでのテスト送信、ユーザーへのプロファイルアクセス権付与などを行う。

## 通知種別

該当なし - 本コマンドはDatabase Mailプロファイルを作成するための設定コマンドであり、通知送信機能は持たない。

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 該当なし（設定作成コマンド） |
| 優先度 | 該当なし |
| リトライ | 該当なし |

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

該当なし - このコマンドは設定作成専用であり、通知送信は行わない。

## 通知テンプレート

該当なし - 通知送信機能なし。

### メール通知の場合

該当なし

### 本文テンプレート

該当なし

### 添付ファイル

該当なし

## テンプレート変数

該当なし

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 手動実行 | ユーザーがコマンドを実行 | なし | 明示的なコマンド実行でのみ動作 |
| パイプライン入力 | SqlInstanceパラメータへの値 | なし | 複数インスタンスをパイプで処理可能 |

### 送信抑止条件

該当なし（設定作成コマンド）

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンド実行] --> B[foreach: 各SqlInstanceを処理]
    B --> C[Connect-DbaInstance接続 MinimumVersion=10]
    C -->|成功| D[ShouldProcess確認]
    C -->|失敗| E[Stop-Function: ConnectionError]
    D -->|Yes| F[MailProfileオブジェクト作成]
    F --> G{Description指定?}
    G -->|Yes| H[Description設定]
    G -->|No| I[Create実行]
    H --> I
    I --> J{MailAccountName指定?}
    J -->|Yes| K{MailAccountPriority指定?}
    J -->|No| L[Add-Member: プロパティ追加]
    K -->|No| M[Priority=1に設定]
    K -->|Yes| N[AddAccount実行]
    M --> N
    N --> L
    L --> O[Select-DefaultView: 既定プロパティ選択]
    O --> P[パイプラインに出力]
    D -->|No| Q{次のinstance?}
    P --> Q
    Q -->|Yes| B
    Q -->|No| R[終了]
    E --> Q
```

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

### 参照テーブル一覧

該当なし（作成処理のみ）

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| msdb.dbo.sysmail_profile | INSERT | 新規プロファイルレコード作成 |
| msdb.dbo.sysmail_profileaccount | INSERT | プロファイルとアカウントの関連付け |

#### 作成されるプロファイル情報

| 操作 | 項目（プロパティ名） | 設定値 | 備考 |
|-----|-----------------|-------|------|
| CREATE | Name | $Profile | 必須、一意 |
| CREATE | Description | $Description | オプション |

#### アカウント関連付け情報（MailAccountName指定時）

| 操作 | 項目 | 設定値 | 備考 |
|-----|-----|-------|------|
| AddAccount | account_name | $MailAccountName | 既存アカウント名 |
| AddAccount | sequence_number | $MailAccountPriority（既定:1） | 優先度（小さいほど高優先） |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| ConnectionError | SQL Serverへの接続失敗 | Stop-Functionで警告出力後、次のインスタンスへ継続 |
| MinimumVersion | SQL Server 2008未満 | Connect-DbaInstance -MinimumVersion 10で自動チェック |
| CreateFailure | プロファイル作成失敗 | Stop-Functionでエラー出力後、次へ継続 |

### リトライ仕様

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

## 配信設定

### レート制限

該当なし（設定作成コマンド）

### 配信時間帯

該当なし

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

- SQL Server への接続には Windows認証、SQL Server認証、Active Directory認証がサポートされる
- SqlCredentialパラメータで代替資格情報を指定可能
- sysadmin権限が必要（SQL Server 2008以上）
- ShouldProcess（-WhatIf, -Confirm）をサポート

## 備考

- SQL Server 2008以上が必要（MinimumVersion 10）
- SQL Server Management Objects (SMO) を使用してプロファイル作成
- 出力オブジェクトはMicrosoft.SqlServer.Management.Smo.Mail.MailProfile型
- MailAccountNameパラメータで作成時にアカウントを関連付け可能
- MailAccountPriorityは優先度を設定（既定:1、数字が小さいほど高優先）
- 追加のアカウント関連付けはSMOのAddAccount()メソッドで後から可能

---

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

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

### 推奨読解順序

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

出力されるMailProfileオブジェクトの構造を理解することが重要。

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

**読解のコツ**: MailProfileオブジェクトを返す。Id、Name、Description、IsBusyProfileが既定表示プロパティ。MailAccountMembershipsプロパティで関連付けられたアカウントにアクセス可能。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | New-DbaDbMailProfile.ps1 | `public/New-DbaDbMailProfile.ps1` | 行83-95: パラメータ定義。SqlInstance、SqlCredential、Profile、Description、MailAccountName、MailAccountPriority、EnableException |

**主要処理フロー**:
1. **行97**: foreachで各SqlInstanceを処理
2. **行98-102**: Connect-DbaInstance -MinimumVersion 10で接続（SQL Server 2008以上）
3. **行104**: ShouldProcess確認
4. **行106**: New-Object Microsoft.SqlServer.Management.SMO.Mail.MailProfileでオブジェクト作成
5. **行107-109**: Description指定時にプロパティ設定
6. **行110**: Create()でデータベースに永続化
7. **行111-115**: MailAccountName指定時にAddAccount()でアカウント関連付け
8. **行117-121**: Add-Member、Select-DefaultViewで出力

#### Step 3: SMOオブジェクト操作を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | New-DbaDbMailProfile.ps1 | `public/New-DbaDbMailProfile.ps1` | 行106-110: SMO MailProfileオブジェクトの作成とCreate |
| 3-2 | New-DbaDbMailProfile.ps1 | `public/New-DbaDbMailProfile.ps1` | 行111-115: AddAccountによるアカウント関連付け |

**主要処理フロー**:
- **行106**: New-Objectでコンストラクタ呼び出し（$server.Mail, $Profile）
- **行107-109**: Test-Boundでデscription指定確認後、プロパティ設定
- **行110**: Create()でデータベースに永続化
- **行111-115**: MailAccountName指定時、Priority未指定なら1を設定してAddAccount()呼び出し

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

```
New-DbaDbMailProfile
    │
    ├─ Connect-DbaInstance (-MinimumVersion 10)
    │      └─ SMO Server接続確立
    │
    ├─ ShouldProcess (WhatIf/Confirm)
    │
    ├─ New-Object Microsoft.SqlServer.Management.SMO.Mail.MailProfile
    │      │
    │      ├─ Test-Bound 'Description'
    │      │      └─ Description プロパティ設定
    │      │
    │      └─ Create() (データベースに永続化)
    │
    ├─ Test-Bound 'MailAccountName'
    │      │
    │      ├─ Priority未指定時: Priority = 1
    │      │
    │      └─ AddAccount($MailAccountName, $MailAccountPriority)
    │
    ├─ Add-Member (カスタムプロパティ追加)
    │
    └─ Select-DefaultView (既定表示プロパティ設定)
```

### データフロー図

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

SqlInstance[]        ───▶  Connect-DbaInstance    ───▶  Server オブジェクト
Profile (string)                   │
                                   ▼
                          New-Object MailProfile   ───▶  MailProfile オブジェクト
                                  │
                                  ├── Description設定（オプション）
                                  │
                                  ▼
                          Create()                 ───▶  msdb永続化
                                  │
                                  ▼
MailAccountName      ───▶  AddAccount()            ───▶  アカウント関連付け
MailAccountPriority  ───▶       │
                                 ▼
                          Select-DefaultView       ───▶  MailProfile出力
                                                         (パイプライン)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| New-DbaDbMailProfile.ps1 | `public/New-DbaDbMailProfile.ps1` | ソース | メインコマンド実装 |
| New-DbaDbMailProfile.Tests.ps1 | `tests/New-DbaDbMailProfile.Tests.ps1` | テスト | Pesterユニットテスト |
| Get-DbaDbMailProfile.ps1 | `public/Get-DbaDbMailProfile.ps1` | ソース | 関連: プロファイル取得 |
| Remove-DbaDbMailProfile.ps1 | `public/Remove-DbaDbMailProfile.ps1` | ソース | 関連: プロファイル削除 |
| New-DbaDbMailAccount.ps1 | `public/New-DbaDbMailAccount.ps1` | ソース | 関連: アカウント作成 |
