SingleSendMail - 發送單條郵件 - Direct Mail

發送單條郵件。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dm:SingleSendMail

none

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
AccountName	string	是	管理主控台中配置的發信地址。	test***@example.net
AddressType	integer	是	地址類型。取值： 0：為隨機帳號 1：為發信地址	1
TagName	string	否	在Direct Mail控制台建立的標籤，用於分類所發送的郵件批次，可以通過標籤來查詢每批郵件的發送情況，另外如果開啟郵件跟蹤功能，發信必須使用郵件標籤。長度為 1-128 個字元，允許英文字母、數字、_、-	test
ReplyToAddress	boolean	是	是否啟用管理主控台中配置好回信地址（狀態須驗證通過），取值範圍是字串 true 或者 false。	true
ToAddress	string	是	目標地址，多個 email 地址可以用逗號分隔，最多 100 個地址（支援郵件組）。	test1***@example.net
Subject	string	是	郵件主題，長度不大於 256 個字元。	Subject
HtmlBody	string	否	郵件 html 本文。注意：HtmlBody 和 TextBody 是針對不同類型的郵件內容，兩者必須傳其一。 URL 傳參限制約 80KB Body 傳參限制約 6MB	body
TextBody	string	否	郵件 text 本文。注意：HtmlBody 和 TextBody 是針對不同類型的郵件內容，兩者必須傳其一。 URL 傳參限制約 80KB Body 傳參限制約 6MB	body
FromAlias	string	否	發信人暱稱，長度小於 15 個字元。例如：發信人暱稱設定為”小紅”，發信地址為 test*@example.net，收信人看到的發信地址為“小紅”test*@example.net。	小紅
ReplyAddress	string	否	回信地址	test2***@example.net
ReplyAddressAlias	string	否	回信地址暱稱	小紅
ClickTrace	string	否	1：為開啟資料跟蹤功能 0（預設）：為關閉資料跟蹤功能。	0
UnSubscribeLinkType	string	否	default: 採用預設策略：對批量類型的發信地址發給特定網域名稱時會產生退訂連結，如帶有關鍵字"gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", "ymail.com"等，具體參照退訂功能產生連結和過濾機制文檔 zh-cn: 產生，給將來埋點到內容準備 en-us: 產生，給將來埋點到內容準備	default
UnSubscribeFilterLevel	string	否	過濾層級。參照退訂功能產生連結和過濾機制文檔 disabled: 不過濾 default: 採用預設策略，批量地址採用發信地址層級過濾 mailfrom: 發信地址層級過濾 mailfrom_domain: 發信網域名稱層級過濾 edm_id: 帳號層級過濾	mailfrom_domain
Headers	string	否	郵件標頭目前可以添加的標準欄位是 Message-ID，List-Unsubscribe，List-Unsubscribe-Post。標準欄位會覆蓋掉郵件標頭中原有的值，非標準欄位需要以 X-User- 開頭，會被追加到郵件標頭中。目前支援 JSON 內送郵件頭最多 10 個，標準欄位和非標準欄位都需要符合標準中對頭的文法要求。	{ "Message-ID": "", "X-User-UID1": "UID-1-000001", "X-User-UID2": "UID-2-000001" }
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	否	指定郵件的密送收件者清單。系統會將與主郵件內容一致的副本分別發送至每個密送地址，但密送資訊對所有收件者（含 ToAddress、BccAddress）均不可見。為了保護密送收件者的隱私，發送給密送收件者的郵件將預設不開啟任何郵件追蹤功能。這意味著，對於密送郵件，系統不會記錄開啟率、點擊率等行為資料。但發送量的計費、和發送詳情、和發送狀態的統計與正常郵件一致。每次發送最多可指定 2 個密送收件者。	1@example.com,2@example.com

返回參數

名稱	類型	描述	樣本值
	object
EnvId	string	事件 ID	600000xxxxxxxxxx642
RequestId	string	請求 ID	2D086F6-xxxx-xxxx-xxxx-006DED011A85

樣本

正常返回樣本

JSON格式

{
  "EnvId": "600000xxxxxxxxxx642",
  "RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
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.	收件者格式不正確，必須有@符號，網域名稱組成為數字，字母，底線，減號和點，帳號組成為數字，字母，底線，減號和點
400	InvalidSubject.Malformed	The specified subject is invalid. It must not exceed 100 characters.	主題錯誤，主題不能超過256個字元
404	InvalidMailAddress.NotFound	The specified mail address is not found.	發信地址未找到

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。