启停企业 SMTP

将 <BASE_URL> 替换为所在企业环境的 API 域名。

Scope：admin.v1.mail-settings.manage
权限项：企业邮箱管理（mail-settings）
权限类型：管理
接口：PUT/api/openapi/v1/mail-servers/current/activation

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

认证与请求头

使用应用 API Key，管理权限不隐含读取或测试发送权限。

名称	位置	类型	必填	说明
`Authorization`	header	string	是	`Bearer <API_KEY>`
`X-Request-Id`	header	string	否	请求日志追踪标识

请求参数

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

请求示例

curl --request PUT \
  --url '<BASE_URL>/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_enabled`	`boolean`	是	`-`	`false`
`ca_pem`	`string`	是	`-`	`"<string>"`
`enabled`	`boolean`	是	自定义 SMTP 是否启用	`false`
`central_available`	`boolean`	是	部署是否提供系统邮件服务	`true`
`delivery_available`	`boolean`	是	自定义 SMTP 或系统服务是否可用于投递	`true`
`configured`	`boolean`	是	`-`	`false`
`from_address`	`string`	是	`-`	`"<string>"`
`from_name`	`string`	是	`-`	`"<string>"`
`host`	`string`	是	`-`	`"<string>"`
`last_test`	`OpenapifacadeMailTestResult`	否	`-`	`{"at":"2026-08-27T10:00:00Z","code":"<string>","server_version":0,"status":"unknown","template_id":"<string>"}`
`last_test.at`	`string · date-time`	是	`-`	`"2026-08-27T10:00:00Z"`
`last_test.code`	`string`	是	`-`	`"<string>"`
`last_test.server_version`	`integer · int64`	是	`-`	`0`
`last_test.status`	`string`	是	`-`	`"unknown"`
`last_test.template_id`	`string`	否	`-`	`"<string>"`
`password_configured`	`boolean`	是	`-`	`false`
`port`	`integer · int64`	是	`-`	`0`
`provider`	`string`	是	`-`	`"central"`
`tls_mode`	`string`	是	`-`	`"tls"`
`updated_at`	`string · date-time`	否	`-`	`"2026-08-27T10:00:00Z"`
`username`	`string`	是	`-`	`"<string>"`
`version`	`integer · int64`	是	`-`	`0`

响应示例

{
  "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

名称	类型	必填	说明	示例
`code`	`string`	否	Stable business error code	`"<string>"`
`detail`	`string`	是	Human-readable error description	`"<string>"`
`details`	`OpenapiErrorDetails`	否	`-`	`{"field":"<string>","reason":"<string>","suggestion":"<string>"}`
`details.field`	`string`	否	Request field that failed validation	`"<string>"`
`details.reason`	`string`	否	Stable validation failure reason	`"<string>"`
`details.suggestion`	`string`	否	Suggested normalized value	`"<string>"`
`error`	`string`	是	Stable HTTP error type	`"<string>"`

响应示例

{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}