1 件のメールを送信します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
dm:SingleSendMail |
none |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| AccountName |
string |
必須 |
Direct Mail コンソールで設定した送信元アドレスです。 |
test***@example.net |
| AddressType |
integer |
必須 |
アドレスタイプです。有効な値は以下のとおりです。 0:ランダムアカウント 1:送信元アドレス |
1 |
| TagName |
string |
任意 |
Direct Mail コンソールで作成したメールタグです。メールタグを使用して、メールのバッチを分類し、各バッチの送信状況をクエリできます。メールトラッキングが有効になっている場合、メールタグを指定する必要があります。 タグの長さは 1~128 文字で、英数字、アンダースコア (_)、ハイフン (-) を使用できます。 |
test |
| ReplyToAddress |
boolean |
必須 |
コンソールで設定した返信先アドレスを使用するかどうかを指定します。返信先アドレスは事前に認証済みである必要があります。有効な値は true および false です。 |
true |
| ToAddress |
string |
必須 |
宛先アドレスです。複数のアドレスを指定する場合は、カンマ (,) で区切ります。最大 100 個のアドレスを指定できます。受信者グループもサポートされています。 |
test1***@example.net |
| Subject |
string |
必須 |
メールの件名です。件名の長さは 256 文字以内である必要があります。 |
Subject |
| HtmlBody |
string |
任意 |
メールの HTML 本文です。 注:HtmlBody または TextBody のいずれかを指定してください。
|
body |
| TextBody |
string |
任意 |
メールのテキスト本文です。 注:HtmlBody または TextBody のいずれかを指定してください。
|
body |
| FromAlias |
string |
任意 |
送信者のニックネームです。ニックネームは 15 文字未満である必要があります。 たとえば、ニックネームを「小紅」と設定し、送信元アドレスを test***@example.net とした場合、受信者側には「小紅」<test***@example.net> として表示されます。 |
小红 |
| ReplyAddress |
string |
任意 |
返信先アドレスです。 |
test2***@example.net |
| ReplyAddressAlias |
string |
任意 |
返信先アドレスのニックネームです。 |
小红 |
| ClickTrace |
string |
任意 |
1:データ追跡を有効にします。 0(デフォルト):データ追跡を無効にします。 |
0 |
| UnSubscribeLinkType |
string |
任意 |
disabled:リンクを生成しません。 default:デフォルトポリシーを使用します。「gmail」「yahoo」「google」「aol.com」「hotmail」「outlook」「ymail.com」などの特定のドメインを含むバッチメールに対して、登録解除リンクが自動的に生成されます。詳細については、「登録解除リンクの生成とフィルタリングメカニズム」をご参照ください。 表示言語は、受信者のブラウザ設定に基づいて自動的に検出されます。 「outlook」、または「ymail.com」。詳細については、「配信停止リンクの生成およびフィルタリングメカニズム」をご参照ください。 表示言語は、受信者のブラウザの設定に基づいて自動的に検出されます。 |
default |
| UnSubscribeFilterLevel |
string |
任意 |
フィルタリングレベルです。詳細については、「登録解除リンクの生成とフィルタリングメカニズム」をご参照ください。 disabled:フィルタリングを行いません。 default:デフォルトポリシーを使用します。バッチアドレスは送信元アドレスレベルでフィルタリングされます。 mailfrom:送信元アドレスレベルでフィルタリングします。 mailfrom_domain:メールドメインレベルでフィルタリングします。 edm_id:アカウントレベルでフィルタリングします。 |
mailfrom_domain |
| Headers |
string |
任意 |
メッセージヘッダーの設定です。 標準フィールドおよび非標準フィールドのいずれも、メッセージヘッダーの構文ルールに従う必要があります。API では、headers フィールドに最大 10 個のヘッダーを指定できます。この制限を超えるヘッダーは無視されます。ただし、SMTP にはこの制限はありません。 1. 標準フィールド Message-ID、List-Unsubscribe、List-Unsubscribe-Post 標準フィールドは、メッセージヘッダー内の既存の値を上書きします。 2. 非標準フィールド 大文字・小文字は区別されません。 a. X-User- で始まるフィールド(これらのフィールドは EventBridge イベントバスや Message Service MNS にプッシュされません。API のみで必要となりますが、SMTP では任意のカスタムヘッダーがサポートされています。) b. X-User-Notify- で始まるフィールド(これらのフィールドは EventBridge イベントバスおよび Message Service MNS にプッシュされ、API および SMTP の両方でサポートされています。) EventBridge または MNS にプッシュされる際、これらのフィールドは header フィールド内に表示されます。 |
{
"Message-ID": " |
| IpPoolId |
string |
任意 |
専用 IP アドレスプールの ID です。専用 IP アドレスを購入している場合、このパラメーターを使用して現在のメールの送信元 IP アドレスを指定します。詳細については、「専用 IP」をご参照ください。 |
e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef |
| Attachments |
array<object> |
任意 |
この機能は最新のソフトウェア開発キット(SDK)でのみ利用可能です。OpenAPI および署名メカニズムではサポートされていません。詳細については、「SDK を使用して添付ファイル付きのメールを送信する方法」をご参照ください。 |
|
|
object |
任意 |
この機能は最新の SDK でのみ利用可能です。OpenAPI および署名メカニズムではサポートされていません。 |
||
| AttachmentName |
string |
任意 |
この機能は最新の SDK でのみ利用可能です。OpenAPI および署名メカニズムではサポートされていません。 |
test.txt |
| AttachmentUrl |
string |
任意 |
この機能は最新の SDK でのみ利用可能です。OpenAPI および署名メカニズムではサポートされていません。 |
C:\Users\Downloads\test.txt |
| Template |
object |
任意 |
テンプレートベースのメールを送信するためのテンプレート情報です。 |
|
| TemplateId |
string |
任意 |
テンプレート ID です。 |
xxx |
| TemplateData |
object |
任意 |
テンプレート内の変数とその値です。 |
|
|
string |
任意 |
テンプレート変数とその値です。 |
{ "name": "Tom", "age": "22" } |
|
| BccAddress |
string |
任意 |
|
1@example.com,2@example.com |
| DomainAuth |
boolean |
任意 |
ドメインレベルの認証を有効にします。
これはドメインレベルの認証にのみ使用します。送信元アドレスレベルの認証では無視してください。 1. コンソールで `domain-auth-created-by-system@example.com` アドレスを作成します。アットマーク (@) より前のプレフィックスは固定し、サフィックスにはご自身のドメインを使用してください。 2. API シナリオ `AccountName` をご自身のドメインに設定します。受信者側には `domain-auth-created-by-system@example.com` として表示されます。 SMTP シナリオ a. `ModifyPWByDomain` API を使用してドメインパスワードを設定します。 b. ドメインと設定したパスワードを使用して認証します。実際の送信元アドレスとして、`mailfrom` フィールドに `user@example.com` のようなカスタムアドレスを渡します。受信者側には `user@example.com` として表示されます。 |
true |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| EnvId |
string |
イベント ID です。 |
600000xxxxxxxxxx642 |
| RequestId |
string |
リクエスト ID です。 |
2D086F6-xxxx-xxxx-xxxx-006DED011A85 |
例
成功レスポンス
JSONJSON
{
"EnvId": "600000xxxxxxxxxx642",
"RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InvalidReceiverName.Malformed | The format of the receiver name is invalid. It must contain the @ sign. The domain must only contain numbers, letters, underscores, minus signs, and periods. The account name must only contain numbers, letters, underscores, minus signs, and periods. | |
| 404 | InvalidMailAddress.NotFound | The specified mail address is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。