テストメール送信

通知設定のテストメールを送信するためのAPIです。Manager画面右上のユーザー名のボタンから［システム設定］を選択した後、［通知］タブを選択したときに表示される画面での操作に相当します。

書式
curl -X POST --header 'Content-Type: application/json'
             --header 'Accept: application/json'
             --header 'X-API-KEY:APIキー'
             -d 'JSON形式のリクエストボディ'
             'http://ホスト名:ポート番号/api/v1/system-settings/notifications/test-email'
リクエストボディ（JSON形式）
{
  "mailSettings": {
    "address": "string",
    "cc": "string",
    "subjectPrefix": "string"
  }
}
リクエストパラメータ（JSON形式）
項目名 リクエストパラメータ 型 値 省略値
宛先(To) mailSettings address 文字列

256文字以下のASCII文字

RFC準拠のメールアドレスを、カンマ（,）で区切って指定できます。

次のいずれかの形式で指定してください。

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

 省略不可
宛先(cc) cc 文字列

256文字以下のASCII文字

RFC準拠のメールアドレスを、カンマ（,）で区切って指定できます。

次のいずれかの形式で指定してください。

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

  
件名のプレフィックス subjectPrefix 文字列

テストメールの件名の先頭に追加する文字列を指定できます。

20文字以下

  
レスポンス
{
  "message": "string",
  "result": "string"
}
レスポンスパラメータ
項目名 レスポンスパラメータ 型 値
メッセージ message 文字列 結果がfailureの場合、エラーの内容が返却されます。
結果 result 文字列

"success" | "failure"

•　success：成功

•　failure：失敗