Email设置¶
说明¶
- 管理渠道设置中默认的邮件渠道,用于通知管理中通知渠道参数选择的默认值
1、email列表、新增email、批量删除email API¶
请求方式: GET(查询) POST(新增) DELETE(批量删除)
请求地址: /api/notification/email/
Content-Type:
新增数据的时候需要指定Content-Type,以下对Content-Type进行说明:
application/x-www-form-urlencoded —— 表示通过表单方式提交
application/json —— 表示传入数据为json格式字符串
查询参数:
参数 | 数据类型 | 是否必须 | 说明 |
offset | int | 否 | 数据起始位置 |
limit | int | 否 | 查询条数 |
name | string | 否 | email名称 |
输入参数(新增):
参数 | 数据类型 | 是否必须 | 说明 |
email_host | string | 是 | 邮件地址 |
email_port | string | 是 | 邮件端口 |
email_user | string | 是 | 用户名 |
email_password | string | 是 | 密码 |
email_tls | int | 是 | 是否使用tls |
email_ssl | int | 是 | 是否使用ssl |
输出参数:
参数 | 数据类型 | 是否必须 | 说明 |
id | int | 是 | email id |
email_host | string | 是 | 邮件地址 |
email_port | string | 是 | 邮件端口 |
email_user | string | 是 | 用户名 |
email_password | string | 是 | 密码 |
email_tls | int | 是 | 是否使用tls |
email_ssl | int | 是 | 是否使用ssl |
批量删除参数:
参数 | 数据类型 | 是否必须 | 说明 |
pk | string | 与pk[]不能都为空 | 主键,多个主键用半角逗号隔开。通过http body传入 |
pk[] | array | 与pk不能都为空 | 主键数组。通过http body传入 |
排序:
参数 | 数据类型 | 是否必须 | 说明 |
ordering | string | 否 |
|
GET返回数据例子:
{
"count": 3,
"next": null,
"previous": null,
"results": [
{
"id": 3,
"email_host": "test@shfanxi.com",
"email_port": 465,
"email_user": "研发",
"email_password": "123456",
"email_tls": 1,
"email_ssl": 1,
"name": "研发"
},
{
"id": 2,
"email_host": "test@shfanxi.com",
"email_port": 465,
"email_user": "测试",
"email_password": "123456",
"email_tls": 1,
"email_ssl": 0,
"name": "测试用户2"
},
{
"id": 1,
"email_host": "smtp.exmail.qq.com",
"email_port": 465,
"email_user": "jer@shfanxi.com",
"email_password": "Chinastock@123",
"email_tls": 1,
"email_ssl": 0,
"name": "测试用户"
}
]
}
新增email返回数据例子:
{
"id": 1,
"email_host": "smtp.exmail.qq.com",
"email_port": 465,
"email_user": "jer@shfanxi.com",
"email_password": "Chinastock@123",
"email_tls": 1,
"email_ssl": 0,
"name": "测试用户"
}
2、获取单个email,修改email、删除email API¶
请求方式: GET(查询) PUT(修改) PATCH(修改) DELETE(删除)
请求地址: /api/notification/email/1/
请求地址中1为email的id
输入/输出参数: 见章节1中输入和输出参数说明,修改数据时输入参数均为非必须
返回数据例子:
{
"id": 1,
"email_host": "smtp.exmail.qq.com",
"email_port": 465,
"email_user": "jer@shfanxi.com",
"email_password": "Chinastock@123",
"email_tls": 1,
"email_ssl": 0,
"name": "测试用户"
}