メールサーバー管理APIガイド (v1.2)

GIIPシステムののアラームおよびユーザー通知のためのSMTPメールサーバー設定を管理するAPIです。このAPIは、管理者権限(uLevel >= 9)を持つユーザーのみが呼び出すことができます。

🔌 メールサーバー管理ページへ →

📋 概要

管理者はこのAPIを通じて、システムで使用する送信用のメールサーバー情報を登録、修正、および無効化することができます。

🔐 権限とセキュリティ

uLevel: 9 (Admin) 以上が必須
パスワード管理: SMTPパスワードはDBに安全に保存されますが、API呼び出し時の漏洩には注意が必要です。

📡 API詳細 (Sk3)

1. メールサーバーリストの照会 (EmailServerConfigList)

コマンド:
```
text=EmailServerConfigList
```
説明: 現在システムに登録されているすべてのSMTPサーバー情報を返します。

2. メールサーバー設定の追加・修正 (EmailServerConfigPut)

コマンド:
```
text=EmailServerConfigPut
```
jsondata:

{
  "escSn": 0,
  "escName": "アラーム専用SMTP",
  "escSmtpHost": "smtp.example.com",
  "escSmtpPort": 587,
  "escSmtpUser": "sender@example.com",
  "escSmtpPassword": "password",
  "escFromEmail": "noreply@giip.com",
  "escFromName": "GIIP Monitoring",
  "escUseSsl": true,
  "escIsActive": true
}

備考:
```
escSn
```
が0の場合は新規登録、0より大きい場合は当該一連番号の設定を修正します。

3. テストメールの送信 (EmailServerConfigSendTest)

コマンド:
```
text=EmailServerConfigSendTest
```

jsondata:

{"escSn": 1, "toEmail": "admin@example.com"}

説明: 指定されたサーバー設定で正常にメールを送信できるかテストします。

🛡️ Sk3(高性能ロギング)の活用

メールサーバー設定のような機密情報の変更時、セキュリティ監査(Audit)およびデータ整合性検証のために

giipApiSk3

エンドポイントを使用できます。

エンドポイント:

https://giipfaw.azurewebsites.net/api/giipApiSk3

管理者のメリット: 設定変更失敗時に詳細なスタックトレースを収集し、呼び出し元のIPおよびシステム情報を記録することで、セキュリティ事故の予防および迅速なトラブルシューティングが可能です。
活用チップ:
```
KVSPut
```
などによる直接的な設定変更よりも、定義された
```
EmailServerConfigPut
```
コマンドをSk3エンドポイント経由で呼び出すことで、ログの整合性を確保してください。

バージョン: 1.3 最終更新日: 2026-04-11 ソースファイル:

giipv3/public/help/api-email.ja.md

関連ドキュメント:

API結果コードガイド (RstVal)