邮件推送事件 -

本文介绍邮件推送通过云监控接入作为事件源发布到事件总线EventBridge的事件类型。

支持的地域

支持邮件推送发布到事件总线EventBridge的地域有华东1（杭州）、德国（法兰克福）、新加坡、美国（弗吉尼亚）。

事件类型

邮件推送支持发布到事件总线EventBridge的事件类型如下所示。

事件类型	type参数值
邮件投递失败	dm:Deliver:Fail
邮件投递成功	dm:Deliver:Succeed
点击事件	dm:Trace:Click
打开事件	dm:Trace:Open

CloudEvents规范中定义的参数解释，请参见事件概述。

邮件投递失败

邮件投递失败时，事件总线EventBridge接收到的示例事件如下所示。

{
  "data": {
    "header": {
      "X-Notify-Message-ID": "test****@example.com"
    },
    "env_id": "60000****",
    "account": "batch****@top",
    "from": "batch****@top",
    "rcpt": "a****@aliyun.com",
    "msg_id": "1df****@example.com",
    "send_time": "2024-04-29T11:07:04+08:00",
    "deliver_time": "2024-04-29T11:07:12+08:00",
    "status": "2",
    "event": "dm:Deliver:Fail",
    "region": "cn-hangzhou",
    "err_code": "554",
    "err_msg": "554  RCPT a****@aliyun.com dosn't exist",
    "failed_type": "SmtpNxBox"
  },
  "id": "8734hhidu983h****",
  "source": "acs:dm",
  "specversion": "1.0",
  "subject": "acs:dm:cn-hangzhou:123456789098****:215672",
  "time": "2024-04-29T11:07:12+08:00",
  "type": "dm:Deliver:Fail",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2024-04-29T11:07:13.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}

data字段包含的参数解释如下表所示。

参数	类型	示例值	描述
header	Object		与电子邮件相关的头。
X-Notify-Message-ID	String	test****@example.com	自定义头X-Notify-Message-ID。
env_id	String	60000****	发送邮件时系统返回的邮件ID。
account	String	batch****@top	发件人的邮箱地址。
from	String	batch****@top	发件人的邮箱地址。
rcpt	String	a****@aliyun.com	收件人的邮箱地址。
msg_id	String	1df****@example.com	邮件的Message-ID字段。
send_time	String	2024-04-29T11:07:04+08:00	邮件接收时间。
deliver_time	String	2024-04-29T11:07:12+08:00	邮件投递完成时间。
status	String	2	投递结果状态。 0：成功。 2：无效地址。 3：接收方认为垃圾邮件。 4：其他失败。
event	String	dm:Deliver:Fail	事件消息的类型。和type相同。
region	String	cn-hangzhou	事件发生的区域。
err_code	String	554	投递完成时接收方ESP返回的码。
err_msg	String	554 RCPT a****@aliyun.com dosn't exist	投递完成时接收方ESP返回的信息。
failed_type	String	SmtpNxBox	投递结果分类。

邮件投递成功

邮件投递成功时，事件总线EventBridge接收到的示例事件如下所示。

{
  "data": {
    "header": {
      "X-Notify-Message-ID": "test****@example.com"
    },
    "env_id": "60000****",
    "account": "batch****@top",
    "from": "batch****@top",
    "rcpt": "a****@aliyun.com",
    "msg_id": "1df****@example.com",
    "send_time": "2024-04-29T11:07:04+08:00",
    "deliver_time": "2024-04-29T11:07:12+08:00",
    "status": "0",
    "event": "dm:Deliver:Succeed",
    "region": "cn-hangzhou",
    "err_code": "250",
    "err_msg": "250 Send Mail OK",
    "failed_type": "SendOk"
  },
  "id": "8734hhidu983h****",
  "source": "acs:dm",
  "specversion": "1.0",
  "subject": "acs:dm:cn-hangzhou:123456789098****:215672",
  "time": "2024-04-29T11:07:12+08:00",
  "type": "dm:Deliver:Succeed",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2024-04-29T11:07:13.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}

关于data字段包含的参数解释，请参见参数解析。

点击事件

点击事件时，事件总线EventBridge接收到的示例事件如下所示。

{
  "data": {
    "operate_time": "2024-04-29T11:25:48+08:00",
    "client_ip": "192.168.XX.XX",
    "env_id": "60000****",
    "from": "batch****@top",
    "rcpt": "a****@aliyun.com",
    "msg_id": "1df****@example.com",
    "event": "dm:Trace:Click",
    "region": "cn-hangzhou",
    "url": "https://www.aliyun.com"
  },
  "id": "8734hhidu983h****",
  "source": "acs:dm",
  "specversion": "1.0",
  "subject": "acs:dm:cn-hangzhou:123456789098****:215672",
  "time": "2024-04-29T11:07:12+08:00",
  "type": "dm:Trace:Click",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2024-04-29T11:07:13.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}

data字段包含的参数解释如下表所示。

参数	类型	示例值	描述
operate_time	String	2024-04-29T11:25:48+08:00	事件操作时间。
client_ip	String	192.168.XX.XX	点击事件的客户端IP。
env_id	String	60000******	发送邮件时系统返回的邮件ID。
from	String	batch****@top	发件人地址。
rcpt	String	a****@aliyun.com	收件人地址。
msg_id	String	1df****@example.com	邮件中的Message-ID字段。
event	String	dm:Trace:Click	事件类型。
region	String	cn-hangzhou	事件发生的区域。
url	String	https://www.aliyun.com	点击的URL。

打开事件

打开事件时，事件总线EventBridge接收到的示例事件如下所示。

{
  "data": {
    "operate_time": "2024-04-29T11:25:48+08:00",
    "client_ip": "192.168.XX.XX",
    "env_id": "60000****",
    "from": "batch****@top",
    "rcpt": "a****@aliyun.com",
    "msg_id": "1df****@example.com",
    "event": "dm:Trace:Open",
    "region": "cn-hangzhou"
  },
  "id": "8734hhidu983h****",
  "source": "acs:dm",
  "specversion": "1.0",
  "subject": "acs:dm:cn-hangzhou:123456789098****:215672",
  "time": "2024-04-29T11:07:12+08:00",
  "type": "dm:Trace:Open",
  "aliyunaccountid": "123456789098****",
  "aliyunpublishtime": "2024-04-29T11:07:13.179PRC",
  "aliyuneventbusname": "default",
  "aliyunregionid": "cn-hangzhou",
  "aliyunpublishaddr": "172.25.XX.XX"
}

关于data字段包含的参数解释，请参见参数解析。