Smtp接口说明

来自亿业科技接口
跳转至: 导航搜索

如何调用

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三种,不填的话默认为 high
 样例如下:
 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