Appearance
蓝邮(LanU)邮箱系统API文档
蓝邮(LanU)邮箱系统:由心蓝自主研发的蓝邮(LanU)邮件服务器系统搭建部署的一套企业邮局域名邮箱系统。
目前心蓝官网的 邮箱账号 和 域名邮箱 都在使用该系统,服务运行稳定,分布式部署,前后端分离,安全又高效。
API开发文档
蓝邮(LanU)邮箱系统支持API,且免费不限次调用,建议使用POST方式。
API服务器地址: https://mail5.lanu.cn:1443
必须的参数
参数 | 值 | 说明 |
---|---|---|
sign 或usersign | 域名邮箱身份使用sign ,邮箱账号身份使用usersign 。sign : 邮局API Key 或者 邮局API Key+t的Md5值 。 usersign : 心蓝邮箱账号API Key 或心蓝邮箱账号API Key+t的Md5值 。 | 1. 邮局API Key 在邮局管理中的邮局配置中设置2. Md5使用Ascii编码 3. 心蓝邮箱账号 API Key 在心蓝用户中心的邮箱账号中设置。 |
t | 当前时间戳(距离1970-1-1后的毫秒数) | JavaScript:parseInt(new Date().getTime()) C#: (DateTime.UtcNow.Ticks - 621355968000000000) / 10000 当直接使用 API Key 作为sign 时,t参数无意义,可不用。 |
1、获取邮件列表
路径: /v1/message/list
参数说明:
参数 | 值 | 必须的 |
---|---|---|
邮箱账号 | 是 | |
folder | 文件夹,可以为inbox,trash,sent items,deleted items,drafts。默认为inbox | 否 |
subject | 标题关键字 | 否 |
from | 发件人关键字 | 否 |
to | 收件人关键字 | 否 |
starttime | 起始邮件时间,如2025-01-15 10:05:30 | 否 |
endtime | 截止邮件时间,如2025-01-15 10:06:30 | 否 |
isread | 阅读状态,-1为未读,1为已读,0为全部(默认) | 否 |
rows | 每页返回记录数,默认为10,最大100 | 否 |
page | 页码,默认为1 | 否 |
返回结果举例:
JSON
{
"total": 1,
"rows": [{
"Id": "174907663752800001",
"Subject": "测试邮件",
"FromName": "张三",
"FromAddr": "zhangsan@domain.com",
"To": "<abc@abc.com>",
"Size": 18632,
"Attach": false,
"Flags": 0,
"IsRead": false,
"Received": "2025-06-01 06:28:37"
}],
"code": 0
}
使用GET请求示例:https://mail5.lanu.cn:1443/v1/message/list?sign=您的API Key&email=admin@domain.com&to=zhangsan@domain.com&subject=MYTEST
2、获取邮件详情
路径: /v1/message/read
参数说明:
参数 | 值 | 必须的 |
---|---|---|
id | 邮件ID。获取邮件列表时返回的id | 是 |
邮箱账号 | 是 |
返回结果举例:
JSON
{
"data": {
"Id": "174907663752800001",
"FromName": "张三",
"FromAddress": "zhangsan@domain.com",
"Size": "17.82 KB",
"IsRead": false,
"Flags": 0,
"Received": "2025-06-05 (周四) 06:28",
"Subject": "测试邮件",
"To": [{
"Address": " abc@abc.com "
}],
"Body":"这是邮件内容"
},
"code": 0
}
使用GET请求示例:https://mail5.lanu.cn:1443/v1/message/read?sign=您的API Key&email=admin@domain.com&id=174907663752800001
3、删除指定邮件
路径: /v1/message/delete
参数说明:
参数 | 值 | 必须的 |
---|---|---|
id | 邮件ID。获取邮件列表时返回的id | 是 |
邮箱账号 | 是 |
返回结果举例:
JSON
{
"msg":“Done”,
"code": 0
}
使用GET请求示例:https://mail5.lanu.cn:1443/v1/message/delete?sign=您的API Key&email=admin@domain.com&id=174907663752800001