メール配信API

contents要素(配信予約)

配信データを定義する要素です。
リクエスト内に、件名・本文を設定してリクエストする方法と、管理画面に設定したテンプレートIDを指定してリクエストする方法があります。

【件名・本文を直接設定】

<contents>
  <image id="1">http://xxxxxxxx/xxxx.gif</image>
  <text id="1"><![CDATA[ユーザー共通文字列]]></text>
  <attach_file>http://xxxxxxxx/xxxx.pdf</attach_file>
  <subject><![CDATA[サンプルメルマガ]]><subject>
  <body part="text"></body>
    省略
</contents>

【テンプレートを指定】

<contents>
  <image id="1">http://xxxxxxxx/xxxx.gif</image>
  <text id="1"><![CDATA[ユーザー共通文字列]]></text>
  <template id="n"/>
</contents>

構成要素(件名・本文を直接設定)

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

  1. image
  2. text
  3. attach_file
  4. subject
  5. body

image

HTMLメール配信時の共通差込画像URLを指定する要素です。

<image id="1">http://xxxxxxxx/xxxx.gif</image>

複数登録することができ、利用するときは属性idの値を指定します。要素「ext_img」でidの値を指定することにより、各送信先アドレスごとに利用する画像を切り替えることができます。

構成要素 画像を選択する際に利用する値・利用する画像が存在するURL
補足説明

  • 共通差込画像を使用する場合は、メール本文中に<img>タグを使用してください。
    画像はHTMLメールでのみ利用できます。
属性名 内容 数値/文字列
id 画像ID 数値

【共通差込画像使用例】

<!-- imgタグのソースに共通差込画像文字列を指定する事で、URLに置き換わります-->
<img src="##ext_img_1##">
注意

  • <image>タグで画像を指定すると、コンテンツ内で利用していない画像についても取得処理をおこないます。
    不要な画像を指定したり大量の画像指定をすると、不必要な画像取得処理が発生し画像取得に失敗する可能性があります。ご利用の際は、必要な画像のみを指定し同一の画像の場合は一つの<image>タグを利用してください。
  • 画像取得に失敗すると配信が実施されません。指定したコンテンツが取得可能であるかよく確認し利用してください。

text

共通差込文言を指定する要素です。

<text id="1"><![CDATA[ユーザ共通文字列]]></text>

複数登録することができ、利用するときは属性idの値を指定します。
要素「ext_txt」でidの値を指定することにより、各送信先アドレスごとに利用する文字列を切り替えることができます。

構成要素 文字列

<![CDATA[ ]]>で囲むか必要に応じてエスケープ処理をおこなってください。

属性名 内容 数値/文字列
id テキストID 数値

attach_file

添付したいファイルのURLを指定する要素です。

<attach_file>http://xxxxxxxx/xxxx.pdf</attach_file>
構成要素 添付ファイルが存在するURL
補足説明

  • 添付できるファイルは最大3件、最大サイズは2Mbyteです。最大サイズは3ファイルの合計になります。
  • 複数添付したい場合は、<attach_file>を複数行記載ください。
    携帯メールアドレスが配信対象となっていても、PC宛メールのみにファイルが添付されます。
  • 配信文字コードが「UTF-8」の場合は、全てのメールにファイルが添付されます。

添付ファイルサイズによって分間の配信通数を制御しておりますのでご注意ください。

ファイルサイズ 配信数
～ 100Kbyte 指定なし
～ 500Kbyte 150通/分
～ 1Mbyte 75通/分
～ 1.5Mbyte 50通/分
～ 2Mbyte 38通/分

配信速度指定（throttle）を指定した場合は、より小さい値の配信速度で送信されます。

subject

メールデータをXML内に定義する際に、メールの件名を指定する要素です。

注意
設定可能なサイズは、500Byte以下となります。
<subject><![CDATA[サンプルメルマガ]]><subject>
構成要素 メール本文（HTMLメールの場合はHTML形式）

<![CDATA[ ]]>で囲むか必要に応じてエスケープ処理をおこなってください。

body

メールデータをXML内に定義する際に、メールの本文を指定する要素です。

<body part="text"></body>
構成要素 メール本文（HTMLメールの場合はHTML形式）

<![CDATA[ ]]>で囲むか必要に応じてエスケープ処理を行ってください。

属性名 内容 数値/文字列 意味
part メール本文 数値 text：テキストパート
html：HTMLパート

HTMLメールの受信対応をしていない端末や受信拒否をしていることがあるため、テキストパートの設定は必須です。

補足説明

  • テキストパートが未設定の場合は自動的に「このメールはhtmlメールです。」と本文に埋め込みます。

要素body内に定義される本文には、差込文字列指定やクリックURLの自動発行機能など、本文中に指定することで利用可能な機能があります。

クリックカウントURL自動発行機能

メール本文中に以下のように設定することで、設定したURLに対しクリックカウント用の圧縮URLを発行し配信時に自動的に埋め込む機能です。

@@url(アクセス先URL)@@

  • アクセス先URLは「”」等で囲まないでください。
  • URL自動発行機能を利用する際、URLリダイレクト期間の初期値は、指定がない場合クリックカウントが有効になってから60日となります。リダイレクト期間後の遷移先も、指定がない場合は弊社で用意するソーリーページへの遷移となります。

なお、URLにユーザ個別のオプションがある場合は以下のように設定します。

@@url(アクセス先のURL)@@/オプションID

アクセス先URLにオプションIDを含めると、クリックカウントURLがユーザ数と同じだけ発行されてしまいますので、ユーザ個別オプションがある場合は、ユーザごとに変更されない部分までをクリックカウント取得URLとし、後続にオプションIDを指定してください。

ユーザ情報差込み機能
  • 管理画面のメール編集画面では、データベースに登録されているユーザ属性情報を差し込む機能があります。これと同様の動作をAPI v1でも実現することができます。
    事前に管理画面で、差込対象の属性名称を確認しておく必要があります。
  • 当機能は要素ext_dataを使用した場合のみ有効です。

（例）
氏名の属性がありフィールド名(DB)が「text_1」となっている場合、フィールド名を「##」で囲むことで氏名を差し込むことができます。

<body part="text">##text_1##</body>

この機能は、テンプレート利用の場合でも使用可能です。

構成要素(テンプレートを指定)

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

  1. image
  2. text
  3. template

template

管理画面で作成済みのテンプレートを使用して配信する要素です。

<template id="n"/>
属性名 内容 数値/文字列
id テンプレートID 数値

要素templateを使用する場合、要素subjectおよび要素bodyは不要です。
テンプレートはサービスごとに設定が可能で、存在しないIDを指定した場合はエラーとなります。

補足説明

  • テンプレートには題名と本文が入力されている必要があります。
    共通差込や個別差込も利用することができます。