接口定义
通过API 发送邮件
请求方式
POST
请求地址
http://10.10.255.196/api/v2/email
请求参数
key 必须项 string 内部应用认证key
to 必须项 string|list 目标邮箱
cc 可选项 list 抄送邮箱
subject 可选项 string 邮件主题
body 可选项 string|bytes 邮件内容
mimetype 可选项 string 邮件格式,支持\["plain","html","base64","image"\],默认 plain
header 可选项 list 邮件头部
说明
mimetype表示邮件的格式类型,mimetype支持参数说明:
plain : 文本类型邮件
html : HTML格式类型邮件
base64: 普通附件格式类型邮件
image : 图片附件格式类型邮件
本接口支持多附件类型一并发送,各个附件的mimetype可以自由组合,具体在Header中指定,附件类型邮件默认base64
header字段不是必选项,但如果要上传附件就必须加上header以便标识附件的requset-id
header结构如下
[
{requset-id:requset-id,key:value,key1:value1},
{requset-id:requset-id,key:value,key1:value1},
]
目前header支持的邮件头部key参数列表:
["mimetype",Content-ID","Content-Type","Content-Disposition","Content-Length","Content-MD5"]
除mimetype以外,其他以Content开头的参数均用于指定附件属性,与通用的HTTP请求参数一致
为保证附件的完整性,我们要求附件发送时除了携带requset-id以外必须上传附件素材的MD5和Length
附件中邮箱的mimetype默认是base64
特别地,如果你需要将图片附件预览展示给收件人,需要在Header中指定"Content-ID"
请求示例
这里我们展示一个带附件文件和预览图片附件的html邮件
{
'key': key,
'to': "test@hcmail.com",
'cc': ["test@hcmail.com",],
'subject': "subject",
'body': "<p>邮件发送测试...</p>
<p><a href="http://www.baidu.com">百度链接</a></p>
<p>图片演示:</p>
<p><img src="cid:image1"></p>",
'mimetype': "html",
'header':[
{
'request-id' : 'fecfec7176ed4048b894ac04be8778e1',
'Content-Length' : '537792',
'Content-Type' : 'text/plain',
'Content-MD5' : '8884f1f5a16d68057d2fa2760211533c',
'Content-Disposition': 'new.txt'
},
{
'mimetype' : 'image'
'Content-Type' : 'text/plain',
'Content-MD5' : '194c7d43bab98fdb35c2ee3b2256ebbf',
'request-id' : '74474312a2d54066a8e6cb5ce8c07b6d',
'Content-Length' : '2271499',
"Content-ID" : 'image1'
'Content-Disposition': '123.png',
}
]
}
返回示例
{'message': 'success', 'data': 3, 'code': 200}