setting(配信予約) – アララメッセージ api v1

配信に関する設定を行う要素です。
send_date以外の構成要素が指定された場合は、要素authで指定されたサービスへ事前に設定されている値を無視し、要素settingに指定した値を利用して配信を行います。

<setting>
  <send_date>now</send_date>
  <from_name><![CDATA[XXXXXXX]]></from_name>
  <from>xxx@xx.jp</from>
  <envelope_from>xxx@xxx.jp</envelope_from>
  <option>
    省略
  </option>
  <throttle>0000</throttle>
  <s_mime use="0"/>
  <opened_flag use="0"/>
</setting>

構成要素

構成要素

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

send_date
from_name
from
option
throttle
s_mime
opened_flag

補足説明

構成要素のうち、一部が定義されている場合はその部分のみ適用し、その他の部分はサービスの設定値を利用します。
サービス設定を使用しない項目もあります。

send_date

配信時刻の設定を行う要素です。

<send_date>now</send_date>

構成要素

now・配信予約日時（YYYY/MM/DD HH:MI形式）

配信予約日時指定の場合は、指定フォーマットが不正だと、正しく登録されない可能性がありますので、注意してください。

from_name

配信時に表示名に表示されるfrom名を設定する要素です。

<from_name><![CDATA[XXXXXXX]]></from_name>

構成要素

from名として表示される文字列

<![CDATA[]]>で囲むか必要に応じてエスケープ処理をおこなってください。
※指定しない場合は管理画面のサービスに設定されている値が適用されます。

from

配信時に表示されるHeader Fromアドレスを設定する要素です。

<from>xxx@xx.jp</from>

構成要素

Header Fromアドレスとして表示するメールアドレス

設定されたデータについて検証は実施しません。設定された値がそのまま利用されます。
※指定しない場合は管理画面のサービスに設定されている値が適用されます。

envelope_from

配信時に使用するEnvelope Fromアドレスを設定する要素です。

補足説明

バウンスメールの戻り先を自社メールサーバに戻したいときだけ利用します。通常は利用しません。
指定した場合、エラーアドレスがカウントできないためエラーフィルターをご利用いただけません。

<envelope_from>xxx@xxx.jp</envelope_from>

構成要素

Envelope Fromアドレスとして使用するメールアドレス

※指定しない場合は管理画面のサービスに設定されている値が適用されます。

option

メール配信オプションに関する要素です。

option要素(配信予約)

throttle

1分間当たりにMTAへ送信されるメール通数を指定する要素です。

<throttle>0000</throttle>

構成要素

1分あたりの配信通数

補足説明

60～10,000通/分で設定してください。「0000」はサンプルとして記載しておりますが、指定した場合管理画面のサービス「メール配信オプション」で指定された値を利用します。「メール配信オプション」を指定していない場合はデフォルト値はMTAが持つ設定値を利用します。
また、値の指定がない(<throttle></throttle>)場合も、管理画面のサービス「メール配信オプション」で指定された値を利用します。「メール配信オプション」を指定していない場合は配信速度指定をおこないません。
添付ファイル機能オプションを利用している場合、ファイルサイズによる配信速度の制御があります。その場合、より小さい値の配信速度で送信されます。詳細は「contents要素(配信予約)」を参照してください。

関連記事contents要素(配信予約)