モジュール名: mail

機能名 説明
configuration/get 異常時通知メールの設定情報を取得します
configuration/set 異常時通知メールの設定情報を変更します
configuration/test 異常時通知メールの設定でテストメールを送信します

機能名: configuration/get

説明

異常時通知メールの設定情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/mail/configuration/get
リクエストパラメーター
なし
リクエスト例
GET /mcapi/mail/configuration/get HTTP/1.1
X-Fs-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果(共通)

実行に成功すると異常時通知メールの設定情報が返ります。
設定情報としては次の情報が取得できます。

以下に各種認証方法の個別の情報と実行結果の例を記します。

実行結果(POP before SMTP認証の場合)

POP before SMTP認証の個別の情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "serverName": "smtp.test.com",
                "useSmtpOverSsl": true,
                "useStartTls": true,
                "port": 25,
                "fromMailAddress": "server@test.com",
                "toMailAddress": "user@test.com",
                "mailSubject": "!!! Flow Service Notification !!!",
                "encoding": "us-ascii",
                "timeOut": 60,
                "authenticationType": "POP before SMTP",
                "pop3ServerName": "pop3.test.com",
                "usePopOverSsl": true,
                "userStartTlsForPop": true,
                "pop3Port": 110,
                "useApop": true,
                "pop3Interval": 0,
                "userName": "guest"
            }
        }
    }
}
実行結果(SMTP認証の場合)

SMTP認証の個別の情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "serverName": "smtp.test.com",
                "useSmtpOverSsl": true,
                "useStartTls": true,
                "port": 25,
                "fromMailAddress": "server@test.com",
                "toMailAddress": "user@test.com",
                "mailSubject": "!!! Flow Service Notification !!!",
                "encoding": "us-ascii",
                "timeOut": 60,
                "authenticationType": "SMTP",
                "userName": "guest",
                "smtpAuthenticationType": "plain"
            }
        }
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5003 設定ファイルの解析に失敗した場合

▲ このページのトップへ

機能名: configuration/set

説明

異常時通知メールの設定情報を変更します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/mail/configuration/set
リクエストパラメーター
なし
リクエスト例

getConfiguraionで取得できる結果と同じ形式のデータをHTTPボディに設定します。
ただし、認証を行う場合、認証用のパスワード(password)を設定する必要があります。
項目が存在しない場合は更新されません。

次の例は認証方法を「POP before SMTP認証」に設定します。

POST /mcapi/mail/configuration/set HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-Fs-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 510

{
    "result": {
        "status": "success",
        "data": {
            "configuration": {
                "serverName": "smtp.test.com",
                "useSmtpOverSsl": true,
                "useStartTls": true,
                "port": 25,
                "fromMailAddress": "server@test.com",
                "toMailAddress": "user@test.com",
                "mailSubject": "!!! Flow Service Notification !!!",
                "encoding": "us-ascii",
                "timeOut": 60,
                "authenticationType": "POP before SMTP",
                "pop3ServerName": "pop3.test.com",
                "usePopOverSsl": true,
                "userStartTlsForPop": true,
                "pop3Port": 110,
                "useApop": true,
                "pop3Interval": 0,
                "userName": "guest",
                "password": "guest"
            }
        }
    }
}
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功すると異常時通知メールの設定情報を変更します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5001 設定ファイルの読み込みに失敗した場合
5002 設定ファイルの書き込みに失敗した場合
5003 設定ファイルの解析に失敗した場合

▲ このページのトップへ

機能名: configuration/test

説明

異常時通知メールの設定情報を使用してテストメールを送信します。

権限

administrator

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/mail/configuration/test
リクエストパラメーター
なし
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功すると異常時通知メールの設定情報の宛先にテストメールが配信されます。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
403 Forbidden 3001 ログインしていなかった場合
500 Internal Server Error 5003 設定ファイルの解析に失敗した場合
5009 テストメールの送信に失敗した場合

▲ このページのトップへ