hMailServer邮局Api
  1. 账号管理
hMailServer邮局Api
  • 介绍
  • 部署教程
  • 域名管理
    • 获取域名列表
      GET
    • 获取域名数量
      GET
    • 批量添加域名
      POST
    • 批量删除域名_根据ID
      POST
    • 批量删除域名_根据域名
      POST
    • 修改域名主邮箱
      GET
    • 获取域名列表_所有
      GET
  • 账号管理
    • 获取账号列表
      GET
    • 获取账号数量
      GET
    • 批量添加账号
      POST
    • 批量删除账号_根据ID
      POST
    • 批量删除账号_根据邮箱
      POST
    • 删除全部账号
      POST
    • 修改账号密码
      GET
    • 批量修改账号密码
      GET
    • 修改邮件转发_根据ID
      POST
    • 修改邮件转发_根据邮箱
      POST
    • 修改自动回复_根据ID
      POST
    • 修改自动回复_根据邮箱
      POST
  • 邮件管理
    • 获取收信邮件列表
      GET
    • 获取收信邮件数量
      GET
    • 获取发信邮件列表
      GET
    • 获取发信邮件数量
      GET
    • 读取邮件内容
      GET
    • 读取最新一封邮件内容
      GET
    • 删除邮件记录
      POST
    • 删除全部邮件记录
      POST
  1. 账号管理

获取账号列表

GET
/api/getEmailList

请求参数

Query 参数
page
string 
当前页
可选
示例值:
1
size
string 
每页尺寸
可选
示例值:
10
domainId
string 
可选
邮箱后缀ID,如果不填则获取全部域名
示例值:
1
user
string 
模糊筛选:邮箱账号
可选
示例值:
test
apikey
string 
可选
安全密钥,使用header或者param参数都可以
默认值:
666
Header 参数
apikey
string 
必需
安全密钥,使用header或者param参数都可以
默认值:
asdasd

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://127.0.0.1:8080/api/getEmailList?page=1&size=10&domainId=1&user=test&apikey=666' \
--header 'apikey;'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
result
array [object {9}] 
必需
id
string 
可选
user
string 
邮箱账号
可选
pass
string 
邮箱密码
可选
forward
string 
转发到邮箱
可选
lock
string 
自动回复开关
必需
0=关闭,1=启用
subject
string 
自动回复主题
必需
content
string 
自动回复正文
必需
expireLock
string 
自动回复过期开关
必需
0=永不过期,1=到期关闭自动回复
expireTime
string 
自动回复过期时间
必需
例如:2024-09-30 00:00:00
timestamp
string 
必需
示例
{
    "code": 200,
    "msg": "请求成功",
    "result": [
        {
            "id": "2325",
            "user": "abc@daeny.cn",
            "pass": "abc",
            "forward": "1330166564@qq.com",
            "lock": "1",
            "subject": "您的邮件我已收到",
            "content": "你好\r\n我现在正在休假,将在休假结束后回复您",
            "expireLock": "1",
            "expireTime": "2024-09-30 00:00:00"
        },
        {
            "id": "2324",
            "user": "test@daeny.cn",
            "pass": "test",
            "forward": "",
            "lock": "0",
            "subject": "",
            "content": "",
            "expireLock": "0",
            "expireTime": "2024-09-29 00:00:00"
        }
    ],
    "timestamp": "1727573118639"
}
修改于 2024-10-04 06:59:39
上一页
获取域名列表_所有
下一页
获取账号数量
Built with