メールテンプレート情報登録API

マーケティングプラットフォームのメールテンプレートを新規登録するためのAPIです。

メソッド名

mailtemplate.post

リクエスト情報

アクセスURL

メソッド	URL
POST	https://{domainname}/services/rest/mailtemplate

URL部パラメータ

なし

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

★ エレメント名：MailTemplate ★ データ型：MailTemplateType

カラム名	必須	データ型	内容
MailType	必須	MailTypeType	メール種別 MailTypeId：MailTypeName 1：テキスト形式 2：HTML形式 3：マルチパート形式
SenderAddress	必須	string	送信者Emailアドレス
SenderName	オプション	string	送信者名
ReplyTo	オプション	string	返信先
ReturnPath	オプション	string	エラー時返信先
MailEditorType	オプション	MailEditorTypeType	エディタ種別 MailEditorTypeId：MailEditorTypeName 1：テキスト 2：旧エディタ 3：エディタ 4：HTMLソース ※指定しない場合はデフォルトのエディタ種別が適用されます。
Title	必須	string	タイトル
Body	オプション	string	本文
Body2	オプション	string	本文2（マルチパート形式におけるHTML文面）
DestinationAddress	オプション	string	宛先Emailアドレスデフォルト：[% VisitorData.email%]
Cc	オプション	string	CC
Bcc	オプション	string	BCC
Charset	オプション	CharsetType	文字コード CharsetId：CharsetName 1：西欧 (ISO-8859-1) 2：Unicode (UTF-8) 3：日本語 (EUC-JP) 4：日本語 (ISO-2022-JP) 5：日本語 (Shift_JIS) 6：簡体字中国語 (GB2312) 7：繁体字中国語 (BIG5) 8：韓国語 (EUC-KR) 9：キリル文字 (ISO-8859-5) 10：キリル文字 (KOI8-R) 11：キリル文字 (Windows-1251)
Seminar	オプション	SeminarRefType	キャンペーン SeminarId：SeminarName ※指定しない場合は全キャンペーン用のテンプレートになります。
MailFile	オプション	MailFileType	添付ファイル MailFileId：ファイルID MailFileName：ファイル名 MailFileExtension：ファイル拡張子
Memo	オプション	strubg	メモ
DkimKey	オプション	DkimKeyType	DKIM DkimKeyId：DKIM ID DkimKeyName：FQDN
MailUsageList	オプション	MailUsageListType	用途のリスト MailUsageの内容は MailUsageId:MailUsageName 1:送信ウィザード/ステップメール用 2:シナリオ ※指定しない場合は空値となります。
SenderDomainAuthentication	オプション	SenderDomainAuthenticationType	送信ドメイン SenderDomainAuthenticationId：送信ドメイン ID SenderDomainAuthenticationName：設定名 ※こちらを指定された場合、SenderAddressの末尾に”@” + 送信ドメインのドメインを付与します。

レスポンス情報

レスポンスコード

コード	内容
201	正常終了

HTTPレスポンスヘッダ

パラメータ名	データ型	内容
Location	string	登録されたリソースへのURL https://{domainname}/services/rest/mailtemplate/{id}

HTTPレスポンスボディ

なし

XMLサンプル

リクエストXMLサンプル

送信ドメインを指定しない場合

<?xml version='1.0' encoding='UTF-8'?>
<MailTemplate xmlns="http://smartseminar.jp/">
　<MailType>
　　<MailTypeId>3</MailTypeId>
　　<MailTypeName>マルチパート形式</MailTypeName>
　</MailType>
　<MailEditorType>
　　<MailEditorTypeId>3</MailEditorTypeId>
　　<MailEditorTypeName>エディタ</MailEditorTypeName>
　</MailEditorType>
　<DkimKeyType>
　　<DkimKeyId>1</DkimKeyId>
　　<DkimKeyName>a01._domiankey.shanon.co.jp</DkimKeyName>
　</DkimKeyType>
　<SenderAddress>failure+sender@shanon.co.jp</SenderAddress>
　<SenderName>Sender Name</SenderName>
　<ReplyTo>failure+replyto@shanon.co.jp</ReplyTo>
　<ReturnPath>failure+returnpath@shanon.co.jp</ReturnPath>
　<Title>メールタイトルをここに書きます</Title>
　<Body>[% VisitorData.name1 %] 様
　メール本文をここに書きます。</Body>
　<Body2>[% VisitorData.name1 %] 様
　&lt;h1&gt;メール本文をここに書きます。&lt;/h1&gt;</Body2>
　<DestinationAddress>[% VisitorData.sub_email %]</DestinationAddress>
　<Cc>failure+cc@shanon.co.jp</Cc>
　<Bcc>failure+bcc@shanon.co.jp</Bcc>
　<Charset>
　　<CharsetId>2</CharsetId>
　　<CharsetName>UTF-8</CharsetName>
　</Charset>
　<Seminar>
　　<SeminarId>1</SeminarId>
　　<SeminarName>テストキャンペーン</SeminarName>
　</Seminar>
　<MailFile>
　　<MailFileExtension>jpg</MailFileExtension>
　　<MailFileId>6409</MailFileId>
　　<MailFileName>pikachu</MailFileName>
　</MailFile>
　<MailUsageList>
　　<MailUsage>
　　　<MailUsageId>1</MailUsageId>
　　　<MailUsageName>送信ウィザード/ステップメール用</MailUsageName>
　　</MailUsage>
　</MailUsageList>
　<Memo>メールメモをここに書きます</Memo>
</MailTemplate>

送信ドメインを指定する場合

<?xml version='1.0' encoding='UTF-8'?>
<MailTemplate xmlns="http://smartseminar.jp/">
　<MailType>
　　<MailTypeId>3</MailTypeId>
　　<MailTypeName>マルチパート形式</MailTypeName>
　</MailType>
　<MailEditorType>
　　<MailEditorTypeId>3</MailEditorTypeId>
　　<MailEditorTypeName>エディタ</MailEditorTypeName>
　</MailEditorType>
　<SenderAddress>failure+sender</SenderAddress>
　<SenderName>Sender Name</SenderName>
　<ReplyTo>failure+replyto@shanon.co.jp</ReplyTo>
　<ReturnPath>failure+returnpath@shanon.co.jp</ReturnPath>
　<Title>メールタイトルをここに書きます</Title>
　<Body>[% VisitorData.name1 %] 様
　メール本文をここに書きます。</Body>
　<Body2>[% VisitorData.name1 %] 様
　&lt;h1&gt;メール本文をここに書きます。&lt;/h1&gt;</Body2>
　<DestinationAddress>[% VisitorData.sub_email %]</DestinationAddress>
　<Cc>failure+cc@shanon.co.jp</Cc>
　<Bcc>failure+bcc@shanon.co.jp</Bcc>
　<Charset>
　　<CharsetId>2</CharsetId>
　　<CharsetName>UTF-8</CharsetName>
　</Charset>
　<Seminar>
　　<SeminarId>1</SeminarId>
　　<SeminarName>テストキャンペーン</SeminarName>
　</Seminar>
　<MailFile>
　　<MailFileExtension>jpg</MailFileExtension>
　　<MailFileId>6409</MailFileId>
　　<MailFileName>pikachu</MailFileName>
　</MailFile>
　<MailUsageList>
　　<MailUsage>
　　　<MailUsageId>1</MailUsageId>
　　　<MailUsageName>送信ウィザード/ステップメール用</MailUsageName>
　　</MailUsage>
　</MailUsageList>
　<SenderDomainAuthentication>
　　<SenderDomainAuthenticationId>2</SenderDomainAuthenticationId>
　　<SenderDomainAuthenticationName>shanon.co.jpの設定</SenderDomainAuthenticationName>
　</SenderDomainAuthentication>
　<Memo>メールメモをここに書きます</Memo>
</MailTemplate>

レスポンスXMLサンプル

なし

制限事項

自動送信用のテンプレートを登録することはできません。そのため、MailKind は「3:キャンペーン個別」、MailCategory は「50:その他」に固定です。また、StopAutoSend は使用できません。
添付ファイル (MailFile) を利用する場合、ファイル情報API (file.post) を利用して予めファイルをアップロードする必要があります。一度使用したファイルは繰り返し指定できません。ファイルのサイズの上限は、システム設定「メール添付のファイルサイズ制限」の設定値と同じで、通常2.5MBです。
宛先Emailアドレス、タイトル、本文、本文2 には差込み項目を設定することができます。間違いのないようご確認の上ご利用ください。
宛先Emailアドレスを変更した場合は、”テスト送信”機能を利用することはできません。
変更した宛先のメールアドレスがエラーになった場合でも、リードの「E-mailアドレスの有効フラグ」がカウントされます。
「Emailアドレス」以外のフィールドを指定した場合、配信停止フォームは利用できません。
Seminarを指定した場合、MailUsageListの項目で「2:シナリオ用」を指定する事はできません。

注意事項

エディタ種別を指定しない場合は、デフォルトのエディタ種別が適用されます。
- メール種別がテキスト形式の場合 → テキスト
- メール種別がHTML形式かマルチパート形式の場合
  - システム設定「メール作成時のHTMLエディタ使用(デフォルト)」が有効 → エディタ
  - システム設定「メール作成時のHTMLエディタ使用(デフォルト)」が無効 → HTMLソース
メール種別に対応していないエディタ種別を指定することはできません。
- メール種別がテキスト形式の場合 → テキストのみ指定できます。
- メール種別がHTML形式かマルチパート形式の場合 → エディタ、HTMLソースのいずれかのみ指定できます。
送信ドメイン(SenderDomainAuthentication)を指定された場合、登録時にSenderAddressの末尾に”@” + 送信ドメインのドメインを付与します。
- そのため、SenderAddressに関してはメールアカウント部(@の前までの文字列)のみ指定してください。
- また、DKIMの指定も不要となります。(送信ドメイン側でDKIMを指定しているため)