API: Mail/xsend

原文鏈接

概覽

mail/xsend 是郵件 API 的升級版本。與 mail/send API 一樣，mail/xsend 提供強大的郵件發送功能，區別于 mail/send API，mail/xsend 無需提交 html 源碼或郵件文本內容，甚至無需提交郵件標題或發件人，僅需提交你在 SUBMAIL MAIL 中創建的郵件項目模板ID，并可以使用變量動態的控制每封郵件的內容。


項目模版ID：

了解如何使用文本變量和超鏈接變量。

使用 mail/xsend API 你將可以使用 SUBMAIL 編輯器 高效、可視化地創建你的觸發郵件，無需管理郵件中的一切靜態資源或編碼（如圖片，html 代碼兼容等問題），甚至移動設備兼容問題，SUBMAIL 編輯器 已為你做好了一切。

---

URL

<主> https://api.mysubmail.com/mail/xsend

<備> https://api.submail.cn/mail/xsend

---

支持格式

格式URL

json	https://api.mysubmail.com/mail/xsend.json（默認）
xml	https://api.mysubmail.com/mail/xsend.xml

---

http 請求方式

請求方式content-type設置

http post	multipart/form-data、x-www-form-urlencoded、application/json

---

是否需要授權

是

參閱 API 授權和驗證機制

---

請求參數

參數類型必需/可選默認描述

appid	string	必需	無	在 SUBMAIL 應用集成中創建的郵件應用ID
to	string	可選	無	收件人地址 (多個聯系人用半角“,”隔開：e.g. "leo <leo>, <retro>, service@submail.cn", SUBMAIL 支持完整的 RFC 822 收件人標準，請確保您的郵件地址的有效性。請參見 維基百科 EMAIL ADDRESS RFC822 文檔)
from	e-mail	必需	無	發件人地址 ，標準的發件人地址 e.g. leo@submail.cn
from_name	string	可選	無	發件人稱呼，顯示名稱 e.g. Submail （50個字符以內）
reply	e-mail	可選	無	回復地址，標準的回復郵件地址 e.g. leo@submail.cn
cc	string	可選	無	抄送地址 (多個抄送地址請用 “ , ”半角逗__號區分，請將抄送聯系人控制在 5 個以內)。
bcc	string	可選	無	密送地址 (多個密送地址請用 “ ,”半角逗__號或區分，請將密送聯系人控制在 5 個以內)。
subject	string	必需	無	郵件標題（200個字符以內,不提交郵件標題，此標題將讀取項目標題)
project	string	可選	無	項目標記(ID)在SUBMAIL>MAIL>項目中，（如果您的賬戶已開通應用集成，提交并驗證了的開發者身份后）你將可以查看你所創建的郵件項目標記。 此參數將根據你提交的標記來確定該發送的項目。
vars	json string	可選	無	使用文本變量動態控制郵件中的文本，參閱 了解如何創建和使用文本變量
links	json string	可選	無	使用超鏈接變量動態控制郵件中的超鏈接，參閱 了解如何創建和使用超鏈接變量
headers	json string	可選	無	自定義 EMAIL 頭文件指令，headers 是一個標準的 JSON 字符串，headers 參數可以讓開發者在 EMAIL 的標頭部分插入自定義指令（500個字符以內）。 如：{"X-Accept-Language": "zh-cn", "X-Priority":"3","X-Mailer": "My Application"}
asynchronous	string	可選	false	異步選項，該值設為 true 時啟用異步發送模式
tag	string	可選	無	自定義標簽功能，該標簽可用作SUBHOOK追蹤（32 個字符以內）
timestamp	UNIX 時間戳	可選	無	參閱 API 授權與驗證機制 > Timestamp UNIX 時間戳
sign_type	string	可選	normal	API 授權模式（ md5 or sha1 or normal ）參閱 API 授權與驗證機制 > 授權和驗證方式
sign_version	string	可選	無	signature加密計算方式(當sign_version傳2時，vars，links參數不參與加密計算)
signature	string	必需	無	應用密匙 或 數字簽名

注意：

Submail 保留 x-submail-smtp-api 指令，請務必不要在郵件標頭中使用此指令自定義的 EMAIL headers 指令通常以字母 X- 開頭，請將此規范應用到你的指令vars, links 和 headers 參數要求嚴格的 JSON 格式，以下是將參數轉換為 JSON 格式的注意事項json 字符串必須以雙引號包含 json 字符串必須是 utf8 編碼 不能有多余的逗號 如：[1,2,] json 字符串首尾必須被大括號{}包含 PS:大多數的語言都有專屬的JSON解析器（ ENCODING 和 DECODEING 方法）。如 PHP，首先將需要的變量以數組形式(如 $var[‘key’]=value) 創建后，使用 json_encode($var)方法創建 JSON 字符串；

---

代碼示例

發送一封測試郵件

POST URL

https://api.mysubmail.com/mail/xsend.json

POST Data

appid=your_app_id &amp;to=leo <leo> &amp;project=ThJBE4 &amp;signature=your_app_key

返回

{"status":"success","return": [{"send_id": "HstDN4","to": "eg@eg.com"}] }

---

發送一封測試郵件，多收件人

POST URL

https://api.mysubmail.com/mail/xsend.json

POST DATA

appid=your_app_id &amp;to=leo <leo>,retro@submail.cn &amp;project=ThJBE4 &amp;signature=your_app_key

返回

{"status":"success","return": [{"send_id": "HstDN4","to": "eg@eg.com"}] }

---

使用地址簿發送一封測試郵件

POST URL

https://api.mysubmail.com/mail/xsend.json

POST DATA

appid=your_app_id &amp;addressbook=subscribe &amp;project=ThJBE4 &amp;signature=your_app_key

返回

{"status":"success","return": [{"send_id": "HstDN4","to": "eg@eg.com"}] }

---

使用 CURL 發送一封測試郵件

發送 CURL

curl -d 'appid=your_app_id&amp;to=leo<leo> &amp;project=ThJBE4&amp;signature=your_app_key' https://api.mysubmail.com/mail/xsend.json

返回

{"status":"success","return": [{"send_id": "HstDN4","to": "eg@eg.com"}] }

---

使用 CURL 發送一封測試郵件,多收件人

發送 CURL

curl -d 'appid=your_app_id&amp;to=leo<leo> ,retro@submail.cn&amp;&amp;project=ThJBE4&amp;signature=your_app_key' https://api.mysubmail.com/mail/xsend.json

返回

{"status":"success","return": [{"send_id": "HstDN4","to": "eg@eg.com"}] }

---

使用 CURL 發送一封測試郵件,使用地址簿中的收件人

發送 CURL

curl -d 'appid=your_app_id&amp;addressbook=subscribe&amp;&amp;project=ThJBE4&amp;signature=your_app_key' https://api.mysubmail.com/mail/xsend.json

返回

{"status":"success","return": [{"send_id": "HstDN4","to": "eg@eg.com"}] }

---

返回值

請求成功

{"status":"success","return": [{"send_id": "HstDN4","to": "eg@eg.com"}] }

請求失敗

{"status":"error","code":"1xx","msg":"error message" }

---

錯誤代碼

參閱 API 錯誤代碼

---

總結

以上是生活随笔為你收集整理的SUBMAIL邮件平台API接口-Mail/xsend的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。