全部產品
Search

搜尋本產品

    Direct Mail：SingleSendMail

    文件中心

    Direct Mail：SingleSendMail

    更新時間：Aug 18, 2026

    傳送單封郵件。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dm:SingleSendMail

    none

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AccountName

    string

    是

    管理主控台中設定的寄件地址。

    test***@example.net
    AddressType

    integer

    是

    地址類型。取值：

    0：為隨機帳號

    1：為寄件地址

    1
    TagName

    string

    否

    在郵件推送主控台建立的標籤，用於分類所傳送的郵件批次，可以透過標籤來查詢每批郵件的傳送情況，另外如果開啟郵件追蹤功能，寄信必須使用郵件標籤。 長度為 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

    • 新版 SDK 採用 Body 傳參限制約 8MB（ java 1.4.0 及以上， python3 1.4.0 及以上， php 1.4.0 及以上 ）

    body
    TextBody

    string

    否

    郵件 text 內文。

    注意：HtmlBody 和 TextBody 是針對不同類型的郵件內容，兩者必須傳其一。

    • URL 傳參限制約 80KB

    • 新版 SDK 採用 Body 傳參限制約 8MB（ java 1.4.0 及以上， python3 1.4.0 及以上， php 1.4.0 及以上 ）

    body
    FromAlias

    string

    否

    寄件者暱稱，長度小於 15 個字元。

    例如：寄件者暱稱設定為「Jane」，寄件地址為 test***@example.net，收件者看到的寄件地址為「Jane」test***@example.net。

    Jane
    ReplyAddress

    string

    否

    回信地址。

    test2***@example.net
    ReplyAddressAlias

    string

    否

    回信地址暱稱。

    Jane
    ClickTrace

    string

    否

    1：為開啟資料追蹤功能

    0（預設）：為關閉資料追蹤功能。

    0
    UnSubscribeLinkType

    string

    否

    disabled: 不產生

    default: 採用預設策略：對批次類型的寄件地址發給特定網域時會產生退訂連結，如帶有關鍵字 "gmail", "yahoo",

    "google", "aol.com", "hotmail",

    "outlook", "ymail.com" 等，具體參照退訂功能產生連結和過濾機制文件

    顯示語言根據收件者的瀏覽器設定自動識別

    default
    UnSubscribeFilterLevel

    string

    否

    過濾層級。參照退訂功能產生連結和過濾機制文件

    disabled: 不過濾

    default: 採用預設策略，批次地址採用寄件地址層級過濾

    mailfrom: 寄件地址層級過濾

    mailfrom_domain: 寄件網域層級過濾

    edm_id: 帳號層級過濾

    mailfrom_domain
    Headers

    string

    否

    郵件標頭設定

    標準欄位和非標準欄位都需要符合標準中對標頭的語法要求，API 寄信最多可透過 headers 欄位傳入 10 個標頭，超出限制會被忽略，SMTP 沒有限制。

    1、標準欄位

    Message-ID，List-Unsubscribe，List-Unsubscribe-Post

    標準欄位會覆蓋掉郵件標頭中原有的值。

    2、非標準欄位

    不區分大小寫

    a、以 X-User- 開頭（不推送到事件匯流排 EB、訊息服務 MNS。僅 API 要求，SMTP 任意自訂）

    b、以 X-User-Notify- 開頭（推送到事件匯流排 EB、訊息服務 MNS。API 和 SMTP 都支援）

    推送到 EB 或 MNS 時，header 欄位下會包含這些欄位

    { "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

    否

    獨立 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

    否

    範本傳送，範本資訊

    使用範本傳送時，將忽略 Htmlbody 和 TextBody 傳值

    TemplateId

    string

    否

    範本 ID。

    xxx
    TemplateData

    object

    否

    範本變數與值。

    string

    否

    範本變數參數與值。

    { "name": "Tom", "age": "22" }
    BccAddress

    string

    否

    • 指定郵件的密件副本收件者清單。

    • 系統會將與主郵件內容一致的副本分別傳送至每個密件副本地址，但密件副本資訊對所有收件者（含 ToAddress、BccAddress）均不可見。

    • 為了保護密件副本收件者的隱私，傳送給密件副本收件者的郵件將預設不開啟任何郵件追蹤功能。這意味著，對於密件副本郵件，系統不會記錄開啟率、點擊率等行為資料。但傳送量的計費、傳送詳情和傳送狀態的統計與正常郵件一致。

    • 每次傳送最多可指定 2 個密件副本收件者。

    注意：SingleSendMail 介面暫無 Cc 副本欄位，如果需要請使用 SMTP 寄信方式。

    1@example.com,2@example.com
    DomainAuth

    boolean

    否

    啟用網域層級認證

    • true

    • false

    僅在網域層級認證時使用，寄件地址層級認證請忽略。

    1、domain-auth-created-by-system@example.com 主控台建立這個地址，@ 前綴保持固定不變，後綴用自己的網域。

    2、

    API 場景

    AccountName 填該網域的自訂寄件地址，收件者看到的寄件者是該自訂寄件地址。

    SMTP 場景

    a. 透過 ModifyPWByDomain 介面設定網域密碼。

    b. 使用網域和設定的密碼認證，真實寄件者 mailfrom 傳自訂的地址，如 user@example.com，收件者看到的寄件者是 user@example.com。

    true

    返回參數

    名稱

    類型

    描述

    樣本值

    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. 收件者格式不正確，必須有 @ 符號，網域組成為數字、字母、底線、減號和點，帳號組成為數字、字母、底線、減號和點。
    404 InvalidMailAddress.NotFound The specified mail address is not found. 寄件地址未找到。

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

    變更歷史

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