Send a test mail

This is an API function to send a test mail of notification settings. This API function corresponds to the operation on the screen that is displayed by clicking the [Notification] tab after selecting the [System Settings] from the [user-name] button that is displayed on the right-top of the operation screen of Manager.

Format
curl -X POST --header 'Content-Type: application/json'
             --header 'Accept: application/json'
             --header 'X-API-KEY:APIKEY'
             -d 'REQUESTBODYINJSONFORMAT'
             'http://HOSTNAME:PORTNUMBER/api/v1/system-settings/notifications/test-email'
Request body (JSON format)
{
  "mailSettings": {
    "address": "string",
    "cc": "string",
    "subjectPrefix": "string"
  }
}
Request Parameter (JSON format)
Item name Request parameter Type Value Default value

Address (To)

 mailSettings address String

Maximum 256 ASCII characters

You can enter email addresses that are based on the RFC and are divided by a comma (,).

Use one of the following formats for the email addresses:

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

 Impossible to omit

Address (Cc)

 cc String

Maximum 256 ASCII characters

You can enter email addresses that are based on the RFC and are divided by a comma (,).

Use one of the following formats for the email addresses:

• foo@example.com

• <foo@example.com>

• foo <foo@example.com>

  

Subject prefix

 subjectPrefix String

You can add the letters to the beginning of the subject for the test email.

Maximum 20 characters

  
Response
{
  "message": "string",
  "result": "string"
}
Response parameter
Item name Response parameter Type Value
Message message String If the "result" is "failure", the content of error is returned.
Result result String

"success" | "failure"