Kirim email transaksional melalui SingleSendMail API - Direct Mail - Alibaba Cloud - Direct Mail

Mengirim satu email.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dm:SingleSendMail

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	Tipe alamat. Nilai valid: `0`: akun acak. `1`: alamat pengirim.	1
TagName	string	No	Tag yang digunakan untuk mengategorikan Batch email. Anda dapat membuat tag di Konsol Direct Mail. Tag memungkinkan Anda mengkueri status pengiriman setiap batch dan diperlukan jika Anda mengaktifkan pelacakan email. Tag harus sepanjang 1 hingga 128 karakter dan dapat berisi huruf, angka, garis bawah (_), dan tanda hubung (-).	test
ReplyToAddress	boolean	Yes	Apakah akan menggunakan alamat balas-ke default yang dikonfigurasi di Konsol. Alamat harus terverifikasi. Nilai valid: true dan false.	true
ToAddress	string	Yes	Alamat email tujuan. Untuk menentukan beberapa alamat, pisahkan dengan koma (,). Anda dapat menentukan hingga 100 alamat.	test1***@example.net
Subject	string	Yes	Subjek email. Subjek dapat sepanjang maksimal 256 karakter.	Subject
HtmlBody	string	No	Badan HTML email. Catatan: Anda harus menentukan `HtmlBody` atau `TextBody`. Ukuran badan dibatasi sekitar 80 KB saat dikirim sebagai parameter URL. Untuk SDK terbaru (Java 1.4.0 atau lebih baru, Python 3 1.4.0 atau lebih baru, dan PHP 1.4.0 atau lebih baru), badan permintaan dibatasi sekitar 8 MB.	body
TextBody	string	No	Badan teks email. Catatan: Anda harus menentukan `HtmlBody` atau `TextBody`. Ukuran badan dibatasi sekitar 80 KB saat dikirim sebagai parameter URL. Untuk SDK terbaru (Java 1.4.0 atau lebih baru, Python 3 1.4.0 atau lebih baru, dan PHP 1.4.0 atau lebih baru), badan permintaan dibatasi sekitar 8 MB.	body
FromAlias	string	No	Nama pengirim. Nama harus sepanjang 15 karakter atau kurang. Misalnya, jika Anda mengatur nama pengirim ke "Xiaohong" dan alamat pengirim adalah `test*@example.net`, penerima melihat pengirim sebagai "Xiaohong" <test*@example.net>.	小红
ReplyAddress	string	No	Alamat balas-ke.	test2***@example.net
ReplyAddressAlias	string	No	Nama tampilan untuk alamat balas-ke.	小红
ClickTrace	string	No	Apakah akan mengaktifkan pelacakan klik. Nilai valid: `"1"` mengaktifkan pelacakan klik, dan `"0"` menonaktifkan pelacakan klik (default).	0
UnSubscribeLinkType	string	No	`disabled`: tidak menghasilkan tautan berhenti berlangganan. `default`: menggunakan Kebijakan default. Untuk alamat pengirim batch, tautan berhenti berlangganan dihasilkan saat mengirim ke domain tertentu yang mengandung kata kunci seperti "gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", dan "ymail.com". Untuk informasi lebih lanjut, lihat Mekanisme pembuatan dan pemfilteran tautan berhenti berlangganan. Bahasa tampilan ditentukan secara otomatis berdasarkan pengaturan browser penerima. format: String.	default
UnSubscribeFilterLevel	string	No	Tingkat pemfilteran. Untuk informasi lebih lanjut, lihat Mekanisme pembuatan dan pemfilteran tautan berhenti berlangganan. `disabled`: tanpa pemfilteran. `default`: menggunakan Kebijakan default. Untuk alamat batch, pemfilteran diterapkan pada tingkat alamat pengirim. `mailfrom`: memfilter pada tingkat alamat pengirim. `mailfrom_domain`: memfilter pada tingkat domain pengirim. `edm_id`: memfilter pada tingkat akun. format: String.	mailfrom_domain
Headers	string	No	Pengaturan header email kustom. Baik bidang Jenis Penyimpanan Standar maupun non-standar harus mematuhi sintaks header standar. Anda dapat menentukan hingga 10 header per panggilan API. Header yang melebihi batas akan diabaikan. Batas ini tidak berlaku untuk SMTP. 1. Bidang Jenis Penyimpanan Standar `Message-ID`, `List-Unsubscribe`, `List-Unsubscribe-Post` Bidang Jenis Penyimpanan Standar menimpa nilai yang ada di header email. 2. Bidang non-standar Tidak peka huruf besar/kecil. a. Bidang yang dimulai dengan `X-User-`: Tidak dikirim ke EventBridge atau Message Service (MNS). Awalan ini hanya diperlukan untuk panggilan API, bukan untuk SMTP. b. Bidang yang dimulai dengan `X-User-Notify-`: Dikirim ke EventBridge dan MNS. Ini didukung untuk panggilan API maupun SMTP. Saat dikirim ke EventBridge atau MNS, objek header berisi bidang-bidang ini.	{ "Message-ID": "", "X-User-UID1": "UID-1-000001", "X-User-UID2": "UID-2-000001", "X-User-Notify-UID1": "UID-3-000001", "X-User-Notify-UID2": "UID-4-000001" }
IpPoolId	string	No	ID pool IP spesifikasi khusus. Jika Anda telah membeli IP spesifikasi khusus, Anda dapat menggunakan parameter ini untuk menentukan pool IP spesifikasi khusus mana yang akan digunakan untuk mengirim email. Untuk informasi lebih lanjut, lihat IP Spesifikasi Khusus. format: String.	e4xxxxxe-4xx0-4xx3-8xxa-74cxxxxx1cef
Attachments	array<object>	No	Fitur ini hanya tersedia melalui SDK terbaru. Fitur ini tidak didukung untuk panggilan OpenAPI atau otentikasi berbasis tanda tangan. Untuk informasi lebih lanjut, lihat Bagaimana cara mengirim email dengan lampiran menggunakan SDK?. format: Array.
	object	No	An object that represents a single attachment.
AttachmentName	string	No	The file name of the attachment.	test.txt
AttachmentUrl	string	No	The local file path of the attachment that the SDK uses.	C:\Users\Downloads\test.txt
Template	object	No	Informasi Templat yang digunakan untuk mengirim email bertemplat. format: Object.
TemplateId	string	No	The template ID.	xxx
TemplateData	object	No	The variables and their values for the template.
	string	No	The parameters and values of the template variables.	{ "name": "Tom", "age": "22" }
BccAddress	string	No	Daftar penerima BCC yang dipisahkan koma. Sistem mengirim salinan email ke setiap penerima BCC. Informasi BCC disembunyikan dari semua penerima, termasuk yang ditentukan di `ToAddress` dan `BccAddress`. Untuk melindungi privasi, fitur pelacakan email (seperti pelacakan buka dan pelacakan klik) dinonaktifkan untuk email yang dikirim ke penerima BCC. Namun, penagihan dan status pengiriman tetap dilacak. Maksimal dua penerima BCC diizinkan per permintaan. Catatan: Operasi API `SingleSendMail` tidak mendukung bidang CC. Untuk mengirim salinan karbon, gunakan SMTP. format: String.	1@example.com,2@example.com
DomainAuth	boolean	No	Apakah akan mengaktifkan otentikasi tingkat domain. `true` `false` Parameter ini hanya digunakan untuk otentikasi tingkat domain. Abaikan untuk otentikasi tingkat alamat pengirim. 1. Buat alamat `domain-auth-created-by-system@example.com` di Konsol. Awalan harus tetap, dan akhiran harus domain Anda. 2. Skenario API Atur `AccountName` ke domain Anda. Penerima melihat pengirim sebagai `domain-auth-created-by-system@example.com`. Skenario SMTP a. Panggil Operasi API `ModifyPWByDomain` untuk mengatur kata sandi untuk domain. b. Lakukan otentikasi dengan domain dan kata sandi yang dikonfigurasi. Kirim alamat kustom, seperti `user@example.com`, sebagai pengirim aktual di perintah `MAIL FROM`. Penerima melihat `user@example.com` sebagai pengirim.	true

Elemen respons

Element	Type	Description	Example
	object
EnvId	string	The event ID.	600000xxxxxxxxxx642
RequestId	string	The request ID.	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.