说明

邮件配置的字段请查看字段说明

列表查询

接口说明

根据查询条件查询邮件配置列表。

接口版本

v1

接口地址

/api-web-v1/emailConfigs

请求方法

GET

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述	默认	示例
query	label	string	false	模糊查询字段		name
query	search	string	false	模糊查询值		测试
query	time	string	false	时间范围查询字段,必须是邮件配置字段中的时间或时间戳字段名，例如createdAt,updatedAt		createdAt
query	range	string[] or string	false	时间范围，开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳		2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z
query	page	number	false	分页第几页	1
query	limit	number	false	单页几条数据	10
query	sort	string	false	根据哪个字段排序	_id	-createdAt
query	select	string	false	只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加-
query	autopopulate	boolean	false	自动关联数据，部分字段自动关联关系表查询，设置这个值可开关自动联表查询	true	false
query	populate	string	false	指定关联表查询,查询多个关联表用逗号分隔		control

请求参数举例

注意

GET请求所有参数类型都会变成string拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "page":"1",
  "limit":"10",
  "sort":"-createdAt",
  "autopopulate":"false"
}

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回数据
-total	number	False	邮件配置总条数
-rows	array	False	当前返回的邮件配置对象列表

返回参数举例

{
  "code": 0,
  "data": {
    "total": 1,
    "rows": [
      {
        "_id": "6214b3978718a3003db54a73",
        "status": 0,
        "secure": true,
        "username": "458054867@qq.com",
        "password": "jrtxugocaxcubjgg",
        "host": "smtp.qq.com",
        "port": "465",
        "control": "6180fc754276ad123c53754d",
        "creator": {
          "_id": "5da855b71816bc001be72f4b",
          "trueName": "王宾宾",
          "username": "15258284638"
        },
        "createdAt": "2022-02-22T09:57:43.170Z",
        "updatedAt": "2022-02-22T09:57:43.170Z",
        "__v": 0
      }
    ]
  }
}

在线调试 (opens new window)

查询邮件配置ID

接口说明

根据邮件配置ID查询邮件配置

接口版本

v1

接口地址

/api-v1/emailConfigs/:id

请求方法

GET

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	邮件配置ID

请求参数举例

注意

GET请求所有参数类型都会拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "_id": "6214b3978718a3003db54a73"
}

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	false	返回邮件配置信息

返回参数举例

{
  "code": 0,
  "data": {
    "_id": "6214b3978718a3003db54a73",
    "status": 0,
    "secure": true,
    "username": "458054867@qq.com",
    "password": "jrtxugocaxcubjgg",
    "host": "smtp.qq.com",
    "port": "465",
    "control": "6180fc754276ad123c53754d",
    "creator": {
        "_id": "5da855b71816bc001be72f4b",
        "trueName": "王宾宾",
        "username": "15258284638"
    },
  }
}

在线调试 (opens new window)

新建

接口说明

新建一个邮件配置。

接口版本

v1

接口地址

/api-v1/emailConfigs

请求方法

POST

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
body	-	Object	True	邮件配置对象字段说明

请求参数举例

{
  "status": 0,
  "secure": true,
  "username": "458054867@qq.com",
  "password": "jrtxugocaxcubjgg",
  "host": "smtp.qq.com",
  "port": "465",
  "control": "6180fc754276ad123c53754d",
  "creator": "5da855b71816bc001be72f4b",
  "createdAt": "2022-02-22T09:57:43.170Z",
  "updatedAt": "2022-02-22T09:57:43.170Z",
  "__v": 0
}

// Make sure to add code blocks to your code group

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回创建的对象

返回参数举例

  {
    "_id": "6214b3978718a3003db54a73",
    "status": 0,
    "secure": true,
    "username": "458054867@qq.com",
    "password": "jrtxugocaxcubjgg",
    "host": "smtp.qq.com",
    "port": "465",
    "control": "6180fc754276ad123c53754d",
    "creator": {
        "_id": "5da855b71816bc001be72f4b",
        "trueName": "王宾宾",
        "username": "15258284638"
    },
    "createdAt": "2022-02-22T09:57:43.170Z",
    "updatedAt": "2022-02-22T09:57:43.170Z",
    "__v": 0
  }

编辑

接口说明

修改邮件配置。取消任务

接口版本

v1

接口地址

/api-v1/emailConfigs/:id

请求方法

PUT

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	修改的邮件配置ID
body	-	Object	True	邮件配置对象字段说明

请求参数举例

{
  "username": "458054867@qq.com",
}

// Make sure to add code blocks to your code group

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回创建的对象

返回参数举例

{
  "code": 0,
  "data": {
    "_id": "6214b3978718a3003db54a73",
    "status": 0,
    "secure": true,
    "username": "458054867@qq.com",
    "password": "jrtxugocaxcubjgg",
    "host": "smtp.qq.com",
    "port": "465",
    "control": "6180fc754276ad123c53754d",
    "creator": {
        "_id": "5da855b71816bc001be72f4b",
        "trueName": "王宾宾",
        "username": "15258284638"
    },
    "createdAt": "2022-02-22T09:57:43.170Z",
    "updatedAt": "2022-02-22T09:57:43.170Z",
    "__v": 0
  }
}

删除

接口说明

删除一个邮件配置。

接口版本

v1

接口地址

/api-v1/emailConfigs/:id

请求方法

DELETE

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	删除的邮件配置ID

请求参数举例

只需发送删除邮件配置的ID

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
message	string	false	成功删除返回complete

返回参数举例

{
    "code": 0,
    "message": "complete"
}

此接口需实际邮件配置。文档不提供删除在线调试