Smtp接口说明:修訂版本之間的差異
Lebesgue.yu(對話 | 貢獻) (以“==如何调用== :1)亿业SMTP接口遵循标准SMTP协议,使用常见的smtpclient类即可完成调用; :2)亿业SMTP接口通过添加额外的header来...”为内容创建页面) |
Lebesgue.yu(對話 | 貢獻) |
||
第 44 行: | 第 44 行: | ||
::<strong>live_category_code</strong>:指定活跃度过滤分类的类别,类别需要事先在亿业平台上添加,不区分大小写。 | ::<strong>live_category_code</strong>:指定活跃度过滤分类的类别,类别需要事先在亿业平台上添加,不区分大小写。 | ||
:6)支持设置优先级别; | :6)支持设置优先级别; | ||
− | ::<strong>priority</strong>:邮件优先级,可设定为 high、median 和 low三种,不填的话默认为 | + | ::<strong>priority</strong>:邮件优先级,可设定为 high、median 和 low三种,不填的话默认为 low |
样例如下: | 样例如下: | ||
X-Easeye-API: { | X-Easeye-API: { |
2020年7月29日 (三) 02:04的最新修訂版本
目錄
如何調用
- 1)億業SMTP接口遵循標準SMTP協議,使用常見的smtpclient類即可完成調用;
- 2)億業SMTP接口通過添加額外的header來支持擴展功能;
- 支持的功能以及實現方法請參考本文下方#SMTP接口支持哪些擴展功能和#SMTP郵件如何支持擴展功能
SMTP接口支持哪些擴展功能
- 1)支持設置郵件類別和任務名稱;
- 主要是為了後續查詢報表時使用,方便操作人員分類/分任務查看不同的類別和任務的發送效果;推薦使用方式如下:
- 郵件類別:設置郵件類別為觸發場景名稱,比如賬單郵件的類別可以是:bill;註冊郵件的類別可以是:registration;
- 任務名稱:設置任務名稱為用戶傳入的任務名稱(如果有的話),或者“類別名稱+觸發日期”,比如bill_201607或者registration_20170207;
- 2)支持設置是否跟蹤打開和跟蹤點擊;
- SMTP郵件系統默認不跟蹤打開和點擊,如果需要跟蹤,請設置為1;
- 3)(可忽略)支持添加退訂鏈接;
- 如果郵件沒有退訂鏈接,系統也會自動補上,所以,本功能可以忽略;
- 4)(可忽略)支持設置自定義跟蹤域名;
- 如果公司有多個網站,且主域名不同,本配置才有意義,否則,本功能可以忽略;
- 5)(可忽略)支持新版活躍度功能;
- 本功能可以優化改善營銷郵件發送效果,但一般情況下,請忽略本功能;
- 6)(可忽略)支持設置優先級別;
- 僅僅在:有私有通道,且發送的事務郵件同時有實時觸發(註冊激活密碼找回)和批量觸發(賬單)的場景下才使用;
- 可以為實時觸發郵件設置較高的優先級別,批量觸發的郵件設置偏低的優先級別,以避免互相干擾;
- 7)支持單封信件定位功能;
- 每封信件可以賦一個唯一的ID,方便同一個接收方短時間多次發送時,能夠快速定位到任意一封郵件;
SMTP郵件如何支持擴展功能
- 擴展功能是通過添加額外的header來實現的;主要有兩個header:“X-Easeye-API”和“X-Easeye-UniqueMsgID”
X-Easeye-API頭部
- 本Header的值是一段 json 字符串,用以傳遞發送的選項;支持的功能和相應的配置值如下:
- 1)支持設置郵件類別和任務名稱;
- category:郵件類別;最大長度100個byte,字符範圍是大小寫字母和阿拉伯數字;
- campaign:郵件任務名稱;最大長度100個byte,字符範圍是大小寫字母和阿拉伯數字;
- 2)支持設置是否跟蹤打開和跟蹤點擊;
- 3)支持添加退訂鏈接;
- 4)支持設置自定義跟蹤域名;
- 5)支持新版活躍度功能;
- 這些功能均通過設置send_options來實現,對應的值可以設定多個選項,如下:
- track_open:是否跟蹤郵件打開,只有當郵件內容為"text/html"時有效,為 1 時跟蹤,其他值不跟蹤。
- track_click:是否跟蹤郵件點擊,為 1 時跟蹤,其他值不跟蹤。
- track_subscription:是否添加退訂鏈接,為 1 時添加,其他值不添加。
- custom_domain:自定義跟蹤域名。要求此域名已在平台驗證通過,否則將採用系統缺省域名。
- filter_by_new_contact_livelines:是否對本次發送啟動新版活躍度過濾,為 1 時啟用,為 0時不啟用。
- live_category_code:指定活躍度過濾分類的類別,類別需要事先在億業平台上添加,不區分大小寫。
- 6)支持設置優先級別;
- priority:郵件優先級,可設定為 high、median 和 low三種,不填的話默認為 low
样例如下: X-Easeye-API: { "category": "Registration", "campaign": "registration email for new users", "send_options": { "track_open": 1, "track_click":1, "track_subscription":1, "custom_domain":"http://linktrace.test.com", "filter_by_new_contact_livelines": 0, }, "priority":"low" }
X-Easeye-UniqueMsgID頭部
- 用以唯一標識一封郵件(對發送方),最大長度50 byte,字符範圍是大小寫字母,阿拉伯數字和減號;
样例如下: X-Easeye-UniqueMsgID: sendseqid-89897254234
SMTP樣例會話
[server]: 220 relay.easeye.com.cn Welcome to Easeye SMTP Relay Server.ESMTP. [client]: EHLO oyrufeng [server]: 250-mx.easeye.net 250 AUTH LOGIN PLAIN [client]: AUTH LOGIN [server]: 334 VXNlcm5hbWU6 [client]: em9yb3NhbQ== [server]: 334 UGFzc3dvcmQ6 [client]: em9ybw== [server]: 235 Authentication successful [client]: MAIL FROM: <test@easeye.com.cn> [server]: 250 ok [client]: RCPT TO: <test@easeye.net> [server]: 250 ok [client]: DATA [server]: 354 End data with <CR><LF>.<CR><LF> [client]: From: "=?utf-8?Q?=E5=8F=91=E9=80=81=E4=BA=BA?="<test@easeye.com.cn> To: <test@easeye.net> Subject: =?utf-8?Q?=E8=BE=93=E5=85=A5=E6=A0=87=E9=A2=98?= Date: Mon, 30 Dec 2013 09:01:24 GMT X-Easeye-UniqueMsgID: uid-12312312312 X-Easeye-API: { "category": "registration", "campaign": "registration20131230", "send_options": { "track_open": 1, "track_click": 1, "track_subscription": 1, "custom_domain": "http://linktrace.test.com" } } MIME-Version: 1.0 Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: quoted-printable <a href=3D"http://www.baidu.com">=E7=99=BE=E5=BA=A6</a> . [server]: 250 ok [client]: QUIT [server]: 221 Bye