Skip to main content

启停企业 SMTP

只修改已保存 SMTP 的启用状态。停用保留配置和密码，无需重传服务器字段，也不需要凭据可读；启用要求已有完整有效配置，开启认证时保存的密码必须可读。不发送测试邮件。

  • Scope：admin.v1.mail-settings.manage
  • 权限项：企业邮箱管理（mail-settings）
  • 权限类型：管理
  • 接口：PUT/api/openapi/v1/mail-servers/current/activation
只修改已保存 SMTP 的启用状态。停用保留配置和密码，无需重传服务器字段，也不需要凭据可读；启用要求已有完整有效配置，开启认证时保存的密码必须可读。不发送测试邮件。

认证与请求头

使用应用 API Key，管理权限不隐含读取或测试发送权限。
名称位置类型必填说明
Authorizationheaderstring是Bearer <API_KEY>
X-Request-Idheaderstring否请求日志追踪标识

请求参数

名称位置类型必填说明
enabledbodyboolean是true 启用，false 停用；false 不需要其他配置参数
versionbodyinteger是查询所得的当前配置版本，非负；配置保存后使用新返回版本

请求示例

curl --request PUT \
  --url 'https://dev-develop.dev-vpc.qwenwork.cn/api/openapi/v1/mail-servers/current/activation' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":false,"version":2}'

响应

200 OK

名称类型必填说明示例
auth_enabledboolean是服务器需要身份认证false
ca_pemstring是自定义 CA 证书（可选）"<string>"
enabledboolean是自定义 SMTP 是否启用false
central_availableboolean是部署是否提供系统邮件服务true
delivery_availableboolean是自定义 SMTP 或系统服务是否可用于投递true
configuredboolean是是否已配置false
from_addressstring是发件邮箱"<string>"
from_namestring是显示名称"<string>"
hoststring是SMTP 服务器地址"<string>"
last_testOpenapifacadeMailTestResult否最近测试结果-
password_configuredboolean是是否已配置密码false
portinteger · int64是端口0
providerstring是邮件投递服务来源"central"
tls_modestring是加密方式"tls"
updated_atstring · date-time否更新时间"2026-08-27T10:00:00Z"
usernamestring是认证账号"<string>"
versioninteger · int64是版本号，用于并发更新校验0

last_test 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
atstring · date-time是测试时间
codestring是错误码
server_versioninteger · int64是邮件服务器配置版本号
statusstring是测试状态；可选值：unknown, accepted, failed
template_idstring否模板 ID
{
  "auth_enabled": false,
  "enabled": false,
  "central_available": true,
  "delivery_available": true,
  "ca_pem": "<string>",
  "configured": false,
  "from_address": "<string>",
  "from_name": "<string>",
  "host": "<string>",
  "last_test": {
    "at": "2026-08-27T10:00:00Z",
    "code": "<string>",
    "server_version": 0,
    "status": "unknown",
    "template_id": "<string>"
  },
  "password_configured": false,
  "port": 0,
  "provider": "central",
  "tls_mode": "tls",
  "updated_at": "2026-08-27T10:00:00Z",
  "username": "<string>",
  "version": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否测试结果详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}