跳转到内容

邮件服务器

邮件服务器配置管理、认证协议及投递策略,以确保跨系统间可靠且合规的邮件通信


查询邮件服务器列表

GET
/api/v1/email/server

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id
类型integer
format"int64"
name
类型string
protocol
类型string
枚举
"SMTP""POP3""IMAP"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方法

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

筛选条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

筛选条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

筛选条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

替换邮件服务器

PUT
/api/v1/email/server

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

添加邮件服务器

POST
/api/v1/email/server

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

删除邮件服务器

DELETE
/api/v1/email/server

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*
类型array
必填
maxItems10
minItems0
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

更新邮件服务器

PATCH
/api/v1/email/server

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

检查已启用的邮件服务器

GET
/api/v1/email/server/check

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

protocol

邮件服务器协议,仅支持 SMTP

类型string
枚举
"SMTP""POP3""IMAP""SMTP"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询邮件服务器详情

GET
/api/v1/email/server/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

邮件服务器ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

启用或禁用邮件服务器

PATCH
/api/v1/email/server/enabled

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布