發(fā)送單條郵件。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級別：是指每個(gè)操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| dm:SingleSendMail | *全部資源 * |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AccountName | string | 是 | 管理控制臺中配置的發(fā)信地址。 | test***@example.net |
| AddressType | integer | 是 | 地址類型。取值： 0：為隨機(jī)賬號 1：為發(fā)信地址 | 1 |
| TagName | string | 否 | 在郵件推送控制臺創(chuàng)建的標(biāo)簽，用于分類所發(fā)送的郵件批次，可以通過標(biāo)簽來查詢每批郵件的發(fā)送情況，另外如果開啟郵件跟蹤功能，發(fā)信必須使用郵件標(biāo)簽。 | test |
| ReplyToAddress | boolean | 是 | 是否啟用管理控制臺中配置好回信地址（狀態(tài)須驗(yàn)證通過），取值范圍是字符串 true 或者 false（不是 bool 值）。 | true |
| ToAddress | string | 是 | 目標(biāo)地址，多個(gè) email 地址可以用逗號分隔，最多 100 個(gè)地址（支持郵件組）。 | test1***@example.net |
| Subject | string | 是 | 郵件主題，長度不大于 100 個(gè)字符。 | Subject |
| HtmlBody | string | 否 | 郵件 html 正文，SDK 限制 80K。注意：HtmlBody 和 TextBody 是針對不同類型的郵件內(nèi)容，兩者必須傳其一。 | body |
| TextBody | string | 否 | 郵件 text 正文，SDK 限制 80K。注意：HtmlBody 和 TextBody 是針對不同類型的郵件內(nèi)容，兩者必須傳其一。 | body |
| FromAlias | string | 否 | 發(fā)信人昵稱，長度小于 15 個(gè)字符。 例如：發(fā)信人昵稱設(shè)置為”小紅”，發(fā)信地址為 test***@example.net，收信人看到的發(fā)信地址為“小紅”test***@example.net。 | 小紅 |
| ReplyAddress | string | 否 | 回信地址 | test2***@example.net |
| ReplyAddressAlias | string | 否 | 回信地址昵稱 | 小紅 |
| ClickTrace | string | 否 | 1：為打開數(shù)據(jù)跟蹤功能 0（默認(rèn)）：為關(guān)閉數(shù)據(jù)跟蹤功能。 | 0 |
| UnSubscribeLinkType | string | 否 | 生成的退訂鏈接類型。參照退訂功能生成鏈接和過濾機(jī)制文檔 disabled: 不生成 default: 采用默認(rèn)策略：對批量類型的發(fā)信地址發(fā)給特定域名時(shí)會生成退訂鏈接，如帶有關(guān)鍵字"gmail", "yahoo", "google", "aol.com", "hotmail", "outlook", "ymail.com"等 zh-cn: 生成，給將來埋點(diǎn)到內(nèi)容準(zhǔn)備 en-us: 生成，給將來埋點(diǎn)到內(nèi)容準(zhǔn)備 | default |
| UnSubscribeFilterLevel | string | 否 | 過濾級別。參照退訂功能生成鏈接和過濾機(jī)制文檔 disabled: 不過濾 default: 采用默認(rèn)策略，批量地址采用發(fā)信地址級別過濾 mailfrom: 發(fā)信地址級別過濾 mailfrom_domain: 發(fā)信域名級別過濾 edm_id: 賬號級別過濾 | mailfrom_domain |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"EnvId": "600000xxxxxxxxxx642",
"RequestId": "2D086F6-xxxx-xxxx-xxxx-006DED011A85"
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 404 | InvalidMailAddress.NotFound | The specified mail address is not found. | 發(fā)信地址未找到 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-02-20 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |