Mengirim satu email.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
dm:SingleSendMail |
none |
*全部资源
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| AccountName |
string |
Yes |
Alamat pengirim yang dikonfigurasi di Konsol Direct Mail. |
test***@example.net |
| AddressType |
integer |
Yes |
Jenis alamat. Nilai yang valid: 0: Akun acak 1: Alamat pengirim |
1 |
| TagName |
string |
No |
Tag email yang Anda buat di Konsol Direct Mail. Gunakan tag untuk mengklasifikasikan batch email dan menanyakan status pengiriman setiap batch. Jika pelacakan email diaktifkan, Anda harus menentukan tag email. Panjang tag dapat berkisar antara 1 hingga 128 karakter dan dapat berisi huruf, angka, garis bawah (_), serta tanda hubung (-). |
test |
| ReplyToAddress |
boolean |
Yes |
Menentukan apakah akan menggunakan alamat balasan yang dikonfigurasi di konsol. Alamat balasan harus telah diverifikasi. Nilai yang valid: true dan false. |
true |
| ToAddress |
string |
Yes |
Alamat tujuan. Untuk menentukan beberapa alamat, pisahkan dengan koma (,). Anda dapat menentukan maksimal 100 alamat. Grup penerima didukung. |
test1***@example.net |
| Subject |
string |
Yes |
Subjek email. Panjang subjek tidak boleh melebihi 256 karakter. |
Subject |
| HtmlBody |
string |
No |
Isi HTML email. Catatan: Tentukan HtmlBody atau TextBody.
|
body |
| TextBody |
string |
No |
Isi teks email. Catatan: Tentukan HtmlBody atau TextBody.
|
body |
| FromAlias |
string |
No |
Nama panggilan pengirim. Nama panggilan harus kurang dari 15 karakter. Contohnya, jika Anda mengatur nama panggilan menjadi "Xiao Hong" dan alamat pengirim adalah test***@example.net, penerima akan melihat pengirim sebagai "Xiao Hong" <test***@example.net>. |
小红 |
| ReplyAddress |
string |
No |
Alamat balasan. |
test2***@example.net |
| ReplyAddressAlias |
string |
No |
Nama panggilan alamat balasan. |
小红 |
| ClickTrace |
string |
No |
1: Mengaktifkan pelacakan data. 0 (default): Menonaktifkan pelacakan data. |
0 |
| UnSubscribeLinkType |
string |
No |
disabled: Tidak ada tautan yang dihasilkan. default: Kebijakan default digunakan. Tautan berhenti berlangganan dihasilkan untuk email batch yang dikirim ke domain tertentu, seperti domain yang mengandung kata kunci seperti "gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", atau "ymail.com". Untuk informasi selengkapnya, lihat Mekanisme pembuatan dan penyaringan tautan berhenti berlangganan. Bahasa tampilan secara otomatis terdeteksi berdasarkan pengaturan browser penerima. "outlook", atau "ymail.com". Untuk informasi selengkapnya, lihat Mekanisme pembuatan dan penyaringan tautan berhenti berlangganan. Bahasa tampilan secara otomatis terdeteksi berdasarkan pengaturan browser penerima. |
default |
| UnSubscribeFilterLevel |
string |
No |
Tingkat penyaringan. Untuk informasi selengkapnya, lihat Mekanisme pembuatan dan penyaringan tautan berhenti berlangganan. disabled: Tidak ada penyaringan. default: Kebijakan default digunakan. Alamat batch disaring pada tingkat alamat pengirim. mailfrom: Penyaringan dilakukan pada tingkat alamat pengirim. mailfrom_domain: Penyaringan dilakukan pada tingkat domain email. edm_id: Penyaringan dilakukan pada tingkat akun. |
mailfrom_domain |
| Headers |
string |
No |
Pengaturan header pesan Baik bidang standar maupun non-standar harus mengikuti aturan sintaksis untuk header pesan. API mendukung maksimal 10 header dalam bidang headers. Header apa pun yang melebihi batas ini akan diabaikan. Namun, SMTP tidak memiliki batasan ini. 1. Bidang standar Message-ID, List-Unsubscribe, List-Unsubscribe-Post Bidang standar akan menimpa nilai yang sudah ada di header pesan. 2. Bidang non-standar Tidak peka huruf besar/kecil a. Bidang yang diawali dengan X-User- (Bidang ini tidak didorong ke event bus EventBridge atau Message Service MNS. Hanya diperlukan untuk API, sedangkan SMTP mendukung header kustom apa pun.) b. Bidang yang diawali dengan X-User-Notify- (Bidang ini didorong ke event bus EventBridge dan Message Service MNS, serta didukung oleh API maupun SMTP.) Saat didorong ke EventBridge atau MNS, bidang-bidang ini muncul di bidang header. |
{
"Message-ID": " |
| IpPoolId |
string |
No |
ID kolam alamat IP spesifikasi khusus. Jika Anda membeli alamat IP spesifikasi khusus, gunakan parameter ini untuk menentukan alamat IP arah keluar untuk email saat ini. Untuk informasi selengkapnya, lihat Dedicated IPs. |
e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef |
| Attachments |
array<object> |
No |
Fitur ini hanya tersedia di kit pengembangan perangkat lunak (SDK) terbaru. Fitur ini tidak didukung oleh OpenAPI atau mekanisme signature. Untuk informasi selengkapnya, lihat Bagaimana cara mengirim email dengan lampiran menggunakan SDK?. |
|
|
object |
No |
Fitur ini hanya tersedia di SDK terbaru. Fitur ini tidak didukung oleh OpenAPI atau mekanisme signature. |
||
| AttachmentName |
string |
No |
Fitur ini hanya tersedia di SDK terbaru. Fitur ini tidak didukung oleh OpenAPI atau mekanisme signature. |
test.txt |
| AttachmentUrl |
string |
No |
Fitur ini hanya tersedia di SDK terbaru. Fitur ini tidak didukung oleh OpenAPI atau mekanisme signature. |
C:\Users\Downloads\test.txt |
| Template |
object |
No |
Informasi templat untuk mengirim email berbasis templat. |
|
| TemplateId |
string |
No |
ID templat. |
xxx |
| TemplateData |
object |
No |
Variabel dan nilainya dalam templat. |
|
|
string |
No |
Variabel templat dan nilainya. |
{ "name": "Tom", "age": "22" } |
|
| BccAddress |
string |
No |
|
1@example.com,2@example.com |
| DomainAuth |
boolean |
No |
Aktifkan otentikasi tingkat domain.
Gunakan ini hanya untuk otentikasi tingkat domain. Abaikan untuk otentikasi tingkat alamat pengirim. 1. Buat alamat `domain-auth-created-by-system@example.com` di konsol. Pertahankan awalan sebelum tanda @ tetap dan gunakan domain Anda sendiri sebagai akhiran. 2. Skenario API Atur `AccountName` ke domain Anda. Penerima akan melihat pengirim sebagai `domain-auth-created-by-system@example.com`. Skenario SMTP a. Atur password domain menggunakan API `ModifyPWByDomain`. b. Lakukan otentikasi menggunakan domain dan password yang ditetapkan. Untuk pengirim sebenarnya, masukkan alamat kustom seperti `user@example.com` di bidang `mailfrom`. Penerima akan melihat pengirim sebagai `user@example.com`. |
true |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
|||
| EnvId |
string |
ID event. |
600000xxxxxxxxxx642 |
| RequestId |
string |
ID permintaan. |
2D086F6-xxxx-xxxx-xxxx-006DED011A85 |
Contoh
Respons sukses
JSONformat
{
"EnvId": "600000xxxxxxxxxx642",
"RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}
Kode kesalahan
|
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. | |
| 404 | InvalidMailAddress.NotFound | The specified mail address is not found. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.