Sends a single email.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dm:SingleSendMail |
none |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AccountName |
string |
Yes |
The sender address configured in the Direct Mail console. |
test***@example.net |
| AddressType |
integer |
Yes |
The address type. Valid values: 0: Random account 1: Sender address |
1 |
| TagName |
string |
No |
The email tag that you create in the Direct Mail console. Use tags to classify email batches and query the sending status of each batch. If email tracking is enabled, you must specify an email tag. The tag can be 1 to 128 characters in length and can contain letters, digits, underscores (_), and hyphens (-). |
test |
| ReplyToAddress |
boolean |
Yes |
Specifies whether to use the reply-to address configured in the console. The reply-to address must be verified. Valid values: true and false. |
true |
| ToAddress |
string |
Yes |
The destination address. To specify multiple addresses, separate them with commas (,). You can specify a maximum of 100 addresses. Recipient groups are supported. |
test1***@example.net |
| Subject |
string |
Yes |
The subject of the email. The subject cannot exceed 256 characters in length. |
Subject |
| HtmlBody |
string |
No |
The HTML body of the email. Note: Specify HtmlBody or TextBody.
|
body |
| TextBody |
string |
No |
The text body of the email. Note: Specify HtmlBody or TextBody.
|
body |
| FromAlias |
string |
No |
The nickname of the sender. The nickname must be fewer than 15 characters. For example, if you set the nickname to "Xiao Hong" and the sender address is test***@example.net, the recipient sees the sender as "Xiao Hong" <test***@example.net>. |
小红 |
| ReplyAddress |
string |
No |
The reply-to address. |
test2***@example.net |
| ReplyAddressAlias |
string |
No |
The nickname of the reply-to address. |
小红 |
| ClickTrace |
string |
No |
1: Enables data tracking. 0 (default): Disables data tracking. |
0 |
| UnSubscribeLinkType |
string |
No |
disabled: No link is generated. default: The default policy is used. An unsubscribe link is generated for batch emails sent to specific domains, such as domains that contain keywords like "gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", or "ymail.com". For more information, see Unsubscribe link generation and filtering mechanism. The display language is automatically detected based on the recipient's browser settings. "outlook", or "ymail.com". For more information, see Unsubscribe link generation and filtering mechanism. The display language is automatically detected based on the recipient's browser settings. |
default |
| UnSubscribeFilterLevel |
string |
No |
The filtering level. For more information, see Unsubscribe link generation and filtering mechanism. disabled: No filtering. default: The default policy is used. Batch addresses are filtered at the sender address level. mailfrom: Filters at the sender address level. mailfrom_domain: Filters at the email domain level. edm_id: Filters at the account level. |
mailfrom_domain |
| Headers |
string |
No |
Message header settings Both standard and non-standard fields must follow the syntax rules for message headers. The API supports a maximum of 10 headers in the headers field. Any headers exceeding this limit are ignored. SMTP, however, does not have this limit. 1. Standard fields Message-ID, List-Unsubscribe, List-Unsubscribe-Post Standard fields overwrite existing values in the message header. 2. Non-standard fields Case-insensitive a. Fields that start with X-User- (These are not pushed to the EventBridge event bus or Message Service MNS. They are required only for the API, whereas SMTP supports any custom header.) b. Fields that start with X-User-Notify- (These are pushed to the EventBridge event bus and Message Service MNS, and are supported by both the API and SMTP.) When pushed to EventBridge or MNS, these fields appear in the header field. |
{
"Message-ID": " |
| IpPoolId |
string |
No |
The ID of the dedicated IP address pool. If you purchased dedicated IP addresses, use this parameter to specify the outbound IP address for the current email. For more information, see Dedicated IPs. |
e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef |
| Attachments |
array<object> |
No |
This feature is available only in the latest software development kit (SDK). It is not supported by OpenAPI or signature mechanisms. For more information, see How do I send an email with attachments using an SDK?. |
|
|
object |
No |
This feature is available only in the latest SDK. It is not supported by OpenAPI or signature mechanisms. |
||
| AttachmentName |
string |
No |
This feature is available only in the latest SDK. It is not supported by OpenAPI or signature mechanisms. |
test.txt |
| AttachmentUrl |
string |
No |
This feature is available only in the latest SDK. It is not supported by OpenAPI or signature mechanisms. |
C:\Users\Downloads\test.txt |
| Template |
object |
No |
The template information for sending template-based emails. |
|
| TemplateId |
string |
No |
The template ID. |
xxx |
| TemplateData |
object |
No |
The variables and their values in the template. |
|
|
string |
No |
The template variables and their values. |
{ "name": "Tom", "age": "22" } |
|
| BccAddress |
string |
No |
|
1@example.com,2@example.com |
| DomainAuth |
boolean |
No |
Enable domain-level authentication.
Use this only for domain-level authentication. Ignore it for sender address-level authentication. 1. Create the `domain-auth-created-by-system@example.com` address in the console. Keep the prefix before the at sign (@) fixed and use your own domain as the suffix. 2. API scenario Set `AccountName` to your domain. The recipient sees the sender as `domain-auth-created-by-system@example.com`. SMTP scenario a. Set the domain password using the `ModifyPWByDomain` API. b. Authenticate using the domain and the set password. For the actual sender, pass a custom address, such as `user@example.com`, in the `mailfrom` field. The recipient sees the sender as `user@example.com`. |
true |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| EnvId |
string |
The event ID. |
600000xxxxxxxxxx642 |
| RequestId |
string |
The request ID. |
2D086F6-xxxx-xxxx-xxxx-006DED011A85 |
Examples
Success response
JSON format
{
"EnvId": "600000xxxxxxxxxx642",
"RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 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. | 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. | The specified mail address is not found. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.