モジュール名: mail

機能名: configuration/get

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

administrator、developer、operator

GET /mcapi/mail/configuration/get HTTP/1.1
X-Fs-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4

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

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

• メールサーバー名（serverName）
• SMTP over SSLの使用設定（useSmtpOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（useStartTls）
  使用する場合は「true」、使用しない場合は「false」
• ポート番号（port）
• Fromメールアドレス（fromMailAddress）
• 通知先アドレス（toMailAddress）
• 件名（mailSubject）
• エンコーディング（encoding）
• タイムアウト（timeOut）
• 認証方法（authenticationType）
  「POP before SMTP認証」の場合は「POP before SMTP」、「SMTP認証」の場合は「SMTP」、認証を行わない場合は「NONE」
  「POP before SMTP認証」あるいは「SMTP認証」の場合は、次の個別の情報が取得できます。

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

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

• POP3サーバー名（pop3ServerName）
• POP over SSLの使用設定（usePopOverSsl）
  使用する場合は「true」、使用しない場合は「false」
  使用する場合のみ次の「STARTTLSの使用設定」が取得できます
• STARTTLSの使用設定（userStartTlsForPop）
  使用する場合は「true」、使用しない場合は「false」
• POP3ポート番号（pop3Port）
• APOPの使用設定（useApop）
  使用する場合は「true」、使用しない場合は「false」
• 間隔（pop3Interval）
• 認証用のユーザー名（userName）

{
    "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認証の個別の情報としては次の情報が取得できます。

• 認証用のユーザー名（userName）
• SMTP認証の方式（smtpAuthenticationType）
  「プレーンテキスト認証」の場合は「plain」、「CRAM-MD5認証」の場合は「cram-md5」

{
    "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"
            }
        }
    }
}

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

▲ このページのトップへ

機能名: configuration/set

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

administrator

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"
            }
        }
    }
}

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

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

{
    "result": {
        "status": "success",
        "data": {}
    }
}

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

▲ このページのトップへ

{
    "result": {
        "status": "success",
        "data": {}
    }
}