邮件微服务平台
一、邮件微服务地址
序
号
环境名
称
访问地址
备
注
1
4
测试环境 http://192.168.100.1:8080/esbmail/api/mail/general/send
生产环境 http://192.168.100.1:8080/esbmail/api/mail/general/send
二、接口定义
1. 说明
本文档用于定义邮件微服务接口的请求规范、请求方式以及具体的报文格式、异常处理
等。
2. 通用参数
2.1. 数据类型
实例
备
注
string(50)
dstring(10)
nstring(10)
数据类
型
string
dstring
nstring
含
义
字
符
串
日
期
字
符
串
数
字
字
符
串
number
string[]
boolean
object
数
值
类
型
字
符
串
数
组
布
尔
类
型
对
象
类
型
整数: number 或
number(10)
浮点数:number(10,2)
true/false
object:reqMessage
对
应
的
详
细
解
释
通
过
另
一
个
表
格
描
述
list
列
表
类
型
list
对
应
的
详
细
解
释
通
过
另
一
个
表
格
描
述
2.2. 终端与服务器使用 HTTP 网络协议通讯
2.3. 所有内容编码使用 UTF-8 格式,内容使用 JSON 数据组织方式
2.4. 请求地址说明
http://${IP}:${PORT}/${APP_NAME}/api/mail/general/send
${IP}:系统 IP 地址
${PORT}:服务端口号
${APP_NAME}:服务应用名称
具体的请求地址,请以实际环境地址进行替换后访问
3. 接口定义
3.1. 邮件通用接口
3.1.1. 邮件发送
接受者、抄送者支持多个,数组形式,如:
["to1@jieyuechina.com","to2@jieyuechina.com"]
3.1.1.1. 请求参数
请求方式: POST
请求地址: http://${IP}:${PORT}/${APP_NAME}/api/mail/general/send
序号
字段
1
from
2
password
3
4
5
to
cc
subject
6
text
7
attachFlag
含
义
发
送
者
发
送
者
密
码
接
受
者
抄
送
者
邮
件
主
题
邮
件
内
容
是
否
有
附
件
数据类型
是否
必填
备注
string
可选
默认:
customer_service@jieyuechina.com
string
可选
如果发送者是
customer_service@jieyuechina.com,
则不传密码,如果发送者不是
customer_service@jieyuechina.com,
则密码必传
如:
string[] 是
["to1@jieyuechina.com","to2@jieyuec
hina.com"]
string[]
可
选
如果有,如:to
string
是 邮件主题名称
string
是 邮件正文内容,支持简单文本和 html
string(2) 是 邮件是否带有附件:是-Y、否-N
string
可选
attachType="Y"时为必输字段,代表附
件的类型,比如:doc=
“application/msword“、pdf=
“application/pdf“、
xls="application/vnd.ms-excel"、
ppt="application/vnd.ms-
powerpoint"、
zip="application/zip"、
png="image/png"、jpg=“image/jpeg”
string
可选
attachType="Y"时为必输字段,代表附
件的名称,比如:验证测试.xls、验证
测试.zip
string
可选
attachType="Y"时为必输字段,
InputStream 转为 16 进制字符编码,
如:FFD8FFE000104A******
附
件
类
型
附
件
名
称
附
件
内
容
8
attachType
9
attachName
10
attachContent
参数注意事项:
如果发送者是邮件微服务默认 customer_service@jieyuechina.com,from 和 password 字
段不必传。
如果没有抄送者,cc 可以不用传。
普通邮件请求参数样例代码:
{
"from":"from@jieyuechina.com",
"password":"密码",
"to": ["to1@jieyuechina.com","to2@jieyuechina.com"],
"cc": ["ccc@jieyuechina.com"],
"subject": "邮件验证",
"text": "这是一个验证邮件,支持 html 发送!"
"attachFlag": "N"
}
带有多附件邮件请求参数样例代码:
{
"from":"from@jieyuechina.com",
"password":"密码",
"to": ["to1@jieyuechina.com","to2@jieyuechina.com"],
"cc": ["ccc@jieyuechina.com"],
"subject": "邮件验证",
"text": "这是一个验证邮件,支持 html 发送!",
"attachFlag": "Y",
"attachInfo": [
{
"attachType": "application/zip",
"attachName": "zip 测试 1.zip",
"attachContent":
"504b0304140008000800468ee242000000000000000000000000090000007469746c652e74787
4db7a6bdbbf2de7363d3a750500504b070807d16c540d0000000a000000504b030414000800080
0468ee2420000000000000000000000000600000030302e6a70679dba6554145ef4f73b303448c
7200d43873433d2ddcdd02a3084d4c030c01022250838744877778780d21d4a4b370202d22288c
fefffac1b6fee8b7beff7bcdc7b9d753eebd4feaeb5ff2dfddb04906ba969aa01b0b00000acff0
6e0df0a4019408087878f874b808f8f4f4848404442fd84849898849e928a8c9ae9290b33d3534
64656b010372bbb000723238f14af80b088b8b8380b375416222a2324262efa3f9360111212921
093809e3c0189b231b289fe7fd6bf1e00050160038b1188c50ec0a6c0025260fd1b00b0fcb74e5
cacff2dc0ff212c6c200e2e1e3e012111f17f092de4006c2c20101b07888b8b83f35f34e8bf380
0870297924d44118fcad0169f1d492d1a9a5840c0a1d4d04b63f4ed1758ccce2b8c9088960e44f
f94938b9b87974f5c42520a027daeaca2aaa6aea1a9656c02333533b7b084db3b383abd7676417
9fbf8a2fdfc03c2df4544be8f8a8e494a4e494dfb989e915958545c525a565e51d9d8d4dcd2dad
6def1a9af7f6070687864746c66766e7e6171e9fbf2d6f6ceeedefec18fc3a3f38bcbabeb9bdbd
f777ffe870b0b00c4fa3ff5ffc845f11f17360e0e1007ff7fb8b0b0d1ff93408183cb268247a96
8886f8ba462170d25a0564a2c68e825e41033fa4563e7f58d88162cbec579fe3f68ff9becff1d5
8d8ff2fb2ff0becffe65a069000b1fedb3c2005401ed0bdf35ae5eb61a1e0019d6bea8748d6f0d
95fb547da1a45b30a30d608c3967879adbd1626aa934fbaf32d07191ffc39eec5069326a719ba2
f173ef9fb5a2ead6c3d6a682876ed7df0c53fcedc0bccbc52d3ddab17de56520012b9c42ce7f17
c5e90d94df21b74198b0e24d57a5e9dad617e3b4546c3b74256af155315c9a6c8680f1767855ec
d0e1e69985013c9fd92956db0b8a84b95bcd02a15892b5e38ecbc30dc8a869bcaf3424759224c7
2b127536cd9a9427a6c02673f17b646486b1f48cf7dde036f69edfc032c4ee2276210f453d2587
aa104b12080a21dea6e3e2b0bf25d329b3feec87343d91251ab718c8e1058a25bf5b430408f6c1
2c57ed53149591e7002ced2570aaf68240b3ca2dc0dfc586d0261a3cb1aa7193a2eab3c2421571
c99a9f9a252af3320f811cb589563e66f4a023cdfa6caf66dbd8571c4c97519bfb01a177a9e2b5
bf935833ba57ab49e7655ced28b4f9dff3d7ee2d7a7de741c0455e17bf1e9b772f34ca33807be2
c90079e55e2c450ae33365f1e7ce411af6113f7988691a89a4be51ac1c731587f12142f419f8f7
620e47acaacc4fa45f4eb78c3088450aa288ce3ef4ebdacbeed5f572aab37fa702c1fa25984a3a
c70a5abf90b750e9dda6ab1cb0e8ef29b3fdb0d1e2a8bebec4d6abaefc7bca2e3a8b19fdfcfa47
5923e7f6a56fc5c2d4ca13772b307196f598798a00810e1c007528709ffc2205b42e4d3449455b
e95c37a90870ab44bc0772f650f6b9f74e8869cd968de305552541020e4d1adea20109035c8c50
29cb9597b511e832641652a8b5b9c1318f76bbcb5d3b78d99e840a789b63660af49417b5e053fb
69853f280c3b47770582c6b5f8d3bd384f6daf5842a61679bce44a7ac4ff4b6a69254e26d3cb66
88cb1a5578af43116e75f4d5a7de69cd7ebc383ac2d1ec31c5577ab2809462b11cb943117774d1
33afd1344a2846e287d15421e023ce42ccb4249cc93de0e409d4b120fcc69b3121bd02b9e0c1a3
905e9533ea7b9f397f5a7413a6c783439e357c86aca6b7dfcf9edd308e3b36c6198c92fbfab7f0
05997222b995e5fac7dac04ac2155233bfb844fb5f86f36932d252f1bc64801f283aba63a22139
a775a9b0f3d37553763e6f83d3ff9d28a1bbf1ff901978c8c664c87d834b55501be7c6c8ef7d2b
51a9e1aff00ae351c83fc2196ac149c2415b3e712795b158333fe33618bb859fe802dabf61ae9e
e6961d551e0c114eab759b66fea299ad826e167f2fe94d808cdb47e4d4b971217457523cb6a011
4e77c7acbcc5eaa7e656dd483c2d950140b824fbfdd3841be344833381a7f82cdf98c4df64f82f
c5301e9b8307951f6d80e42370ffeeccc19e1bf491b3ffb59a0e392cfc94a0cdb3e190a38476ef
5ba9de7a2d63fe1c61116f883b67c37117279dbceb258202903012a82a89e47ac9982348d810a1
227213dbd80ede2b975cdfdd870bece5a45206487c68e9f9ccd39258d9b4564f73c74a1d9e86b6
48be89b0421152d42063d3c94e9026e9286e00de5c4cec4418b5524771a7d290e3f179d2fc4727
eb6da7d77cdeb4536b96f92f0732f676b5f61cbc95a3770365b6c782adb7b7dadf18c0964bb6dd
b7d78769ed689e182a91f1ccf04ba5a4caaf90f708c2dff74a4fb1bf5e1ac361891c411c640cf1
9f80f90a8da37cc236415161bdb15e058a3527eb24f3910fadbd4be5eb6661afc49645cca1a853
12d96b3b7bf739ec2e7beaed4db7619882af82844683b849a2949334868c29a82824d6c8b082c9
6526512a4e1d489e270ff94d328a73afa9bca1f9a466ba69726eb5220b8cc7deedc4ae33fc0af1
48b933d1523d2ae8398a6b2c6921481e8c71674c3b044ea367145cd7e43d2d4923e4f629a2a3d5
3907e099946ac2b7b6fa6c425ad9149986f9d970b2fad7fdc61fad0bba0f9ad0623cbe53bb78f5
2da9ff7ee205ba81f582766b9e26f92887677d376ae0bb87a3be96bdc1bd02a9da8b9d0de1a904
0dbe0a564ef31267c5a2b891fb97706e40619f8577df0e8306922a72b9586951f7a31b634a8580
abf4aa14386691c40650cd29e496ca490effa1ee9071fbe10301d6de45910db9734ff4cb0d3a22
b9732d2a015bb375689863c0ab56425fa42adaa02ab3e843fb51af17dc8439fb1fc03c08c63c67
68bdeb525c65c1c38f7851ebfd8cf2c5d9f518973ff197b299eb1695c46316ec7e9a016a77386c
39c172164bbb4c5a112c3cb80368c0f880debe427cb0278ca068fd404a13422c734d6f1f908c75
5a040ee720935481adbbb21512f64b289c65e9c78949e79077edaf44bde81e2caa36cbef086e86
3e331ccaf3b429049cf116fdf771525b9be5a11b78fe0989b7331ab379b77ef3baeabc86b07f8e
3224b86a9ed5ab4867457b5b490d4337cb51a869a938cdf90395c1fd034531fa95b8724d6492f8
a2090dd2094697192cd074697ad711c929d245ca7d7c40ce20956954331e8f6e3e4237ee73743a
648ae4d50e2b08c6f1de444f89a2e61128cefc5cd44b63e5c635f59916a0f16aba71f1d39b4bc6
ceabad01ac09ec023d31aefc070c148e9d5b965ecca13f37972b25831f692fef89f5d36bb9eb9a
0e514ed0043cf511648e86bb56da08f009e580c92e7e49d2396e20e1467a67ec4d251288922921
e408a3ab4bad1738a56925c4a469c657d848f4ed7d344e50b38ec0d038973e7bda6eedca5f89e1
42c920c383122ffccdab86f6c0b0a8415104bad5d315f6b2d9f3aa6b283eea17d6e865f29c213e
f669969efb1f22636d696923411fd8793fa8587596f3a478ab158f61244a6392a1e1a8ccb27970
a239701d3cd4c65118cf07f80798ba7b18b3988a357b7ce7d030cc9a7411d350c218eed1a26274
6659cef11a911c1c4071300ac5b4fe9d9f64cd1baab2b7285113a676eaf3f2cca0fff004f31031
1802991a120576d43335d4912f626d1b0093ffa4a2c3dc993213c3d595773412127ee9a18211a4
50c294369e0dc3785177d00000e39723d79d4d12610deada13cccf67a84fe5a96e725dc5e32f6e
98ac74b256cbce08cea68fc9bf7d1300ea1fa9567b9a735b13fd5b01f3baaa4ccb816b57d15888
06db522d3d07219698e179a9c7309e9c5e988e5812b265cdace7ab75ad72e8d8a34dfb5f0c5cc2
804ecce8ccf933ec069bd34a12d57e984f3fdefb9380cd6cb0058ab968a81d6780445639dced3c
5a6e85d873e6c524f54cf6da5c1cab880c745ec0e80f7a7ab85c1f22889619822ee076f2c3346f
8dcae8956691aafb2559ac5e368108920071db2236e35241f5ef35a07ad4e95cf409d807e5b5a4
513a9bd6497829f3387fcfb2dae8573752441934a9a0e9cf2f2ddbda95a0488cbd0eb8745ba563
b0083f57b0ef5e263ac21267188818863b7aded18b6c3f21a6bdb7148ab7c88f7d3bb499aa3fa2
749744059de1a952b416bf6d1d7e02fd68939d118168fbec6b7d3b49097fab22ee88c8cdd189d3
4d3dddce6894513daf73259edef668c92354d1d3939a59d6576e22d8d19dc48a0cc85a14b71c9e
2cd91e978ce3ce219f902ae967aa41f41e13c170e25fc2b4c4d56c1cb2213d31e14aaaf77c844a
690097a72ddc71fb58f7da2bb420a0c521c701248fdf117e31eaf9f94ccd1f24b4cedc5b0d7084
ea87e766250c032ff8beb5f6b2a5d8de8a298a688a4b12b9548603e90c5b55f5515f06a4674dc7
96d1c9cd7c47298c4b84311e87d2ea8c66c1a056ecf76e511c568a0d710c1349872630d747807e
3d29e1b4832c33563e1f28db8ba9210f7dda626f1fcbe5b211b3c4d7d78a2a81aa12d5acedb7e2
d939dd9826ae5c48846f0e1115e9f5c570652cd957867c189b27c81090a6783668968312e3d06d
0129ff3aad8d0a0392ebd47809bcda0fcaa5d4fe2f09e1283a48d5568995e2dfab98d3b2a047a7
8dd5371f54a6c4a91efd7ecf3c28a65ec1df0fd4db5b310b6a556a5f27b0e3e4d690d99bca1ba9
5559613624947bbb10ef7e17c19e415a8c45d918192ae2bd39983247d027926837c7855627b64f
6cc95afb759c474d97f77d367b8db7afe74ada6a6a83535055bc36d07837e18b4ed94582df57ff
5a67b29379c1afc2459eb8ca31833983af416912362d0d5a90662641633082a9bc0e4dbc1f4f0e
b2b2fd7f8aa5a7f9fb37c767d3d363265d829b0fa8ab3da83bf1586ff6aa8e2b07a8ab323f94c6
fa53ef099e21f536b77b91a46335192de7130fc6b40e64cda966d9be84889df2ac155d1c45b85c
4bf956aa6bd11528c3432d9e70f95b33d25437ffbf1011543d28e1965bcf7d0f57ea195a61f10d
05f3ee7bd58c6217bc0354316fd24a4b630612f64f83641120f58f70ac1074be7e317428787109
40ef337c6f6ff3937d2c9b58be0085f91307aa1f9e1f3bb06eb6a3c0139328181ab61cbaf510eb
649c8168a8c5e59c0c1e2a1397370423fc82e77adbbf2a1c4c38d3b062d64f2de409fa4aceda25
ac01d55f02daae3f23484642506ef48bd45d91fa722f060ac9fef77149c1583ae5a56ea0af0560
4da5c8fedc85c97bd581698ed53961af1bbe5c8afb0b117b8a84db77c8de521c6d76363f27480e
1bbd5bbe5d018d255e6ab8fb782ce1ceced508fce10c58727d6fa4dba84fe20422e87e9cf7af23
9046ebd518d4dbcbbc9d933cd59684a05e0427136184df9b0f96e07ad38686f7d34323cd6f20a1
aef8313fa28314f779a7de2f25adbabbc388c8129025b7da976b4f78079de08c42c1bdad0f9fb0