メールを送信するためのAPIです。

URL

  • POST 
    http://{AppPot Server name}:{Port}/{Context root}/api/{companyId}/{appId}/{appVersion}/emails

Authentication

ユーザー認証が完了している必要があります。

Content-Type: application/json
apppot-token: token

Name Data Format Description
apppot-token String (Required) Login APIの結果得られたユーザートークン

Request parameters

Name Data Format Description
mailFrom String (Required) 送信元メールアドレス
mailTo List (Option) 送信先（To）メールアドレスリスト
mailCc List (Option) 送信先（Cc）メールアドレスリスト
mailBcc List (Option) 送信先（Bcc）メールアドレスリスト
sendingRouteName String (Required) 送信先経路
subject String (Option) メール件名
body String (Option) メール本文

Request example

Ex1: Send Mail（メールアドレス1件）

{
  "mailFrom":"XXX01@ncdc.co.jp",
  "mailTo":["XXX02@ncdc.co.jp"],
  "sendingRouteName":"SES",
  "subject":"メール送信",
  "body":"メールを送信しました",
}

Ex2: Send Mail（メールアドレス複数件）

{
    "mailFrom":"XXX01@ncdc.co.jp",
    "mailTo":["XXX02@ncdc.co.jp","XXX03@ncdc.co.jp"],
    "sendingRouteName":"SES",
    "subject":"メール送信",
    "body":"メールを送信しました",
}

Ex3: Send Mail（Cc,Bcc指定）

{
      "mailFrom":"XXX01@ncdc.co.jp",
      "mailTo":["XXX02@ncdc.co.jp"],
      "mailCc":["XXX03@ncdc.co.jp","XXX04@ncdc.co.jp"],
      "mailBcc":["XXX05@ncdc.co.jp"],
      "sendingRouteName":"SES",
      "subject":"メール送信",
      "body":"メールを送信しました",
}

Response example

{
    "errCode": 0,
    "status": "OK",
    "description": null
}

Response properties

Name Data Format Description
errCode int Response error code: 0, 101, 105, 106, 107, 109, 120, 121, 122, 132, 199, 303, 500
status String (Required) API result status value.
description String (Optional) Detail status if error.