Send Mail Template¶

本接口可通过指定邮箱发送特定模板邮件，模板邮件中存在自定义参数可供调用者进行替换，请求发送成功时，邮件发送请求将被放入消息队列，用户可收到一个 eventId，后续可通过 eventId 查看实际发送结果。

请求格式¶

POST https://{apigw-address}/notification-center-service/v2.0/template/email

请求参数 (URI)¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	组织ID。如何获取orgId信息>>

请求参数 (Body)¶

名称	必需/可选	数据类型	描述
variables	必需	Map<String, String>	邮件模板所需使用的替换变量，模板所对应需要使用的变量可到 EnOS管理控制台中选择消息推送管理 > 邮件 > 邮件模板页面查看。
templateCode	必需	String	模板标识符（Identifier）
toAddresses	必需	List<String>	收件人的邮箱地址列表
ccAddresses	可选	List<String>	需要添加邮件抄送人时的地址列表
senderCode	必需	String	发件箱标识符，用于配置本邮件通过哪个邮箱进行发送，可在 EnOS管理控制台中选择消息推送管理 > 邮件 > 邮件设置页面查看，若不传入本参数会默认通过notice的邮件通道发送
priority	可选	Enum	消息发送优先度，默认P2，不需特殊配置
extras	可选	/	仅当邮件内需要添加自定义的多行表格时才需要进行传递，会替换SYS_TABLE变量

响应参数¶

名称	必需/可选	数据类型	描述
eventId	必需	String	发送邮件或短信请求时返回供用户查询结果的eventId

错误码¶

代码	错误信息	描述
32404	email address is not exist in this organization	不存在发件人邮箱信息
32404	email template is not exist	邮件模板不存在
32400	variable not in template	模板内自定义变量错误
32400	the format of mail address is illegal	收件人邮箱（抄送邮箱）地址格式不正确
32535	fail to authenticate the smtp server	smtp服务器认证失败

示例¶

请求示例¶

url: https://{apigw-address}/notification-center-service/v2.0/template/email?orgId=yourOrgId
method: POST
requestBody:
{
  "variables": {},
  "ccAddresses": [],
  "templateCode": "",
  "priority": "P2",
  "toAddresses": [
    "xxx@univers.com"
  ],
  "senderCode":"",
  "extras":{
     "table":{
        "header": ["comuln_1","comuln_2", ... "comuln_n" ],
        "rows": [["comuln_1","comuln_2", ... "comuln_n" ], ["comuln_1","comuln_2", ... "comuln_n" ], ... ["comuln_1","comuln_2", ... "comuln_n" ]]
     }
  }
}

返回示例¶

{"code":0, "msg":"OK", "submsg":"", "requestId": null, "data":{"eventId": "evt16062008765401}}

异常示例¶

{"code":32403, "msg":"the quota is run out, test quota is limited", "submsg":"Permission denied: tunnel.quota.run.out", "data": null, "requestId": null}