配信予約

contents（配信予約）

contents（配信予約）

要素delivery内のcontentsについて説明します。

"contents":{
  "subject":"##sample_1##xxxxxxxxxxxxxxxxxxxxxxxx",
  "body":{
    "text":"xxxxxxxxxxx##sample_2##xxxxxxxxxxxxxxxx",
    "html":"xxxxxxxxxxx##sample_3##xxxxxxxxxxxxxxxx"
  },
  "encode":0
  "attachments-list":[
    {
      "filename": "sample_1.txt",
      "mimetype": "text/plain",
      "data": "c2FtcGxlXzHjga7jg4fjg7zjgr/jgafjgZnjgIIK"
    },
    {
      "filename": "sample_2.txt",
      "mimetype": "text/plain",
      "data": "c2FtcGxlXzLjga7jg4fjg7zjgr/jgafjgZnjgIIK"
    }
  ],
  "cc": "cctest1@example.com,cctest2@example.com",
  "bcc": "bcctest1@example.com,bcctest2@example.com"
}

配信予約処理、deliveryについては、こちらをご参照ください。

配信予約

delivery（配信予約）

構成

以下の要素で構成されます。

構成要素
  1. subject
  2. body
  3. encode
  4. attachments-list
  5. cc
  6. bcc

 

subject

件名を設定します。

"subject":"##sample_1##xxxxxxxxxxxxxxxxxxxxxxxx"

件名は、差し込みが利用できます。

mailing-list（配信予約）

注意事項

  • subject(件名)には、改行などの制御コードは使用不可です。
  • 設定可能なサイズは500Byte以下となります。

body

メール本文を設定します。

"body":{
  "text":"xxxxxxxxxxx##sample_2##xxxxxxxxxxxxxxxx",
  "html":"xxxxxxxxxxx##sample_3##xxxxxxxxxxxxxxxx"
}

HTMLメール利用時はマルチパートでの配信を推奨します。テキストメールとHTMLメールの両方をご指定ください。

補足説明 HTMLメール受信拒否や、テキストメールのみ受信許可しているケースでは、HTMLパートが表示されないケースがあります。
注意事項

  • メール本文は、textもしくはhtmlの要素いずれかが必須となります。
  • html要素のみを指定した場合、text要素には固定文言が設定されます。固定文言の変更はできません。
  • 本番配信の前に、コンテンツ内容を確認するためにテスト配信をおこなってください。
  • text要素およびhtml要素にて、１行あたり設定可能なサイズは900Byteとなります。900Byteを超える場合、改行コード（0x0A）を適宜設定し、コンテンツを作成してください。
  • 差し込みを利用した場合、差し込まれたデータを含めて、１行が1,000Byte以下となる必要があります。差し込んだ結果、1000Byteを超えた場合は、配信失敗となります。
  • text要素およびhtml要素に設定可能なコンテンツは、両方合わせて150KByte以下である必要があります。

text

"text":"xxxxxxxxxxx##sample_2##xxxxxxxxxxxxxxxx"

テキストメールを指定します。 差し込みが利用できます。

html

"html":"xxxxxxxxxxx##sample_3##xxxxxxxxxxxxxxxx"

HTMLメールを指定します。 差し込みが利用できます。

encode

メールのエンコードを指定します。

"encode":0

メール配信時の文字エンコードを数値で指定します。

数値 説明
0 UTF-8
1 送信先ドメインによる自動判定

encodeを指定しない場合は、UTF-8で配信されます。

UTF-8

送信先のドメインにかかわらず、件名および各パートのメール本文を、UTF-8で配信します。

注意事項

  • フィーチャーフォンではUTF-8に対応していない機種が存在しますのでご注意ください。

送信先ドメインによる自動判定

各メールアドレスのドメインパートを確認し、文字エンコードを判定します。

キャリア 文字コード
docomo Shift_JIS
au ISO-2022-JP
Softbank Shift_JIS
上記以外 ISO-2022-JP

キャリア絵文字の利用が可能です。キャリア絵文字はこちらの代替文字を指定してください。

補足説明 キャリアアドレスで受信しているスマートフォンの場合も、判別したキャリア毎の文字コードで配信されます。

attachments-list

添付ファイルを設定します。

"attachments-list":[
  {
    "filename": "sample.txt",
    "mimetype": "text/plain",
    "data": "5re75LuY44OV44Kh44Kk44Or44Gu44K144Oz44OX44Or44Gn44GZ44CCCg=="
  }
]

最大で10個までの添付ファイルを設定可能です。

注意事項

  • 添付ファイルの設定には、filename、mimetype、data 全ての要素が必須となります。
  • 設定可能な添付ファイルの総ファイルサイズは、base64エンコードする前の状態で2MByte以下となります。 ただし、settings の"ignore_attachments_size":"true"が指定されている場合は、2MByteよりも大きなサイズのファイルを設定可能です。
    • リクエスト総サイズ6MByteまで 
      "ignore_attachments_size":"true"
補足説明 mailing-list内の to の device を 2のフィーチャーフォンにした場合、ファイルは添付しません。
補足説明 添付ファイルが設定されている場合、throttle値の自動制御が行われます。 自動制御により適用されるthrottleの値は以下の表をご参照ください。

総ファイルサイズ throttleの値
100KByte以下 適用なし
100KByteより大きく500KByte以下 150
500KByteより大きく1MByte以下 75
1MByteより大きく1.5MByte以下 50
1.5MByteより大きく2MByte以下 38
2MByteより大きい 25

settingsのthrottleで指定された値 と 自動制御により適用されるthrottleの値のうち、より小さい値で送信されます。

filename

添付ファイル名を設定します。

"filename":"sample.txt"
補足説明 拡張子を含めた状態で添付ファイル名を設定してください。

mimetype

添付ファイルのMIMEタイプを設定します。

"mimetype":"text/plain"
MIMEタイプの取得例
$ file --mime-type -b sample.txt
text/plain

data

添付ファイルをbase64エンコードしたデータを設定します。

"data":"5re75LuY44OV44Kh44Kk44Or44Gu44K144Oz44OX44Or44Gn44GZ44CCCg=="
base64エンコードしたデータの取得例
$ cat sample.txt
添付ファイルのサンプルです。
$ base64 -i sample.txt -o result.txt
$ cat result.txt
5re75LuY44OV44Kh44Kk44Or44Gu44K144Oz44OX44Or44Gn44GZ44CCCg==

cc/bcc

cc、bcc宛先を指定します。

"cc": "cctest1@example.com,cctest2@example.com",
"bcc": "bcctest1@example.com,bcctest2@example.com"

複数の宛先を指定する場合は、カンマ区切りで指定します。 ccを指定した場合には、各宛先にcc宛先が表示されます。

mailing-list（配信予約）

注意事項

  • cc/bccを指定した場合、mailing-list要素に設定可能な宛先は１件です。
  • cc/bccに指定可能なメールアドレス数は、それぞれ5件です。
  • メールアドレスのみ指定可能です。
  • bccヘッダは付与されません。
  • cc/bccの宛先についても、エラーフィルターのフィルター対象となります。
補足説明 cc/bccに指定されたメールアドレスも、エラーフィルターによるフィルター対象となります。 mailing-list要素に設定されたメールアドレスを含め、それぞれがエラーフィルターで配信除外された場合の挙動は以下となります。

条件 挙動
toの宛先が配信除外 cc/bccの宛先へ配信なし。
cc/bcc宛先が配信除外 フィルタされた対象アドレスを除き配信。その際、cc/bccの宛先が0件となっても、toへの配信は行われる。