Skip to content

接口文档

TIP

有些请求参数支持模糊匹配,可以传入%, 示例:'admin' 等值匹配, 'admin%' 开头匹配, '%@example.com' 结尾匹配, '%admin%' 包含匹配

生成Token

接口说明:用于生成确认身份的令牌,填入Authorization请求头,全局只有一个,重新生成旧的会失效

接口地址POST /api/public/genToken

请求参数

参数类型必填说明
emailstring管理员邮箱
passwordstring邮箱密码

返回示例

json
{
  "code": 200,
  "message": "success",
  "data": {
      "token": "9f4e298e-7431-4c76-bc15-4931c3a73984"
  }
}

邮件查询

接口地址POST /api/public/emailList

请求头

Header必填说明
Authorization身份令牌

请求参数

参数类型必填默认值说明
toEmailstring收件人邮箱,支持模糊
sendNamestring发件人名字,支持模糊
sendEmailsting发件人邮箱,支持模糊
subjectsting邮件主题,支持模糊
contentstring邮件html,支持模糊
timeSortstringdesc时间排序(asc 最旧,desc 最新)
typeinteger邮件类型 (0 收件,1发件,空 全部)
isDelinteger是否删除 (0 正常,2删除,空 全部)
numinteger1页码
sizeinteger20每页数量

返回示例

json
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "emailId": 999,                         // 邮件id
      "sendEmail": "[email protected]",       // 发件人邮箱
      "sendName": "hello",                    // 发件人名字
      "subject": "Hello word",                // 邮件主题
      "toEmail": "[email protected]",         // 收件人邮箱
      "toName": "admin",                      // 收件人名字
      "createTime": "2099-12-30 23:99:99",    // 接收或发送的时间(UTC 时间)
      "type": 0,                              // 邮件类型 (0 收件 1 发件)
      "content": "<div>Hello word</div>",     // 邮件HTML
      "text": "Hello word",                   // 邮件纯文本
      "isDel": 0                              // 是否删除 (0 正常 1 删除)
    }
  ]
}

添加用户

接口地址POST /api/public/addUser

请求头

Header必填说明
Authorization身份令牌

请求参数

参数类型必填描述
listarray <object>用户数组
└─ emailstring邮箱地址
└─ passwordsting密码,不填自动生成
└─ roleNamesting权限身份名,不填自动选择默认权限身份

返回示例

json
{
  "code": 200,
  "message": "success",
  "data": null
}