域名与邮箱地址

Domains and mailboxes

读取域名并创建、启停、切换或删除邮箱地址。

Read domains and create, enable, switch, or delete mailbox addresses.

本分类共 5 个端点。返回 完整 API 索引 或 API 架构与安全说明。

GET /api/domains

读取可用收件域名 / List available receiving domains

返回当前实例中的域名及其启用状态和邮箱数量。

Return instance domains with active state and mailbox counts.

cURL 示例

curl --request GET \
  --url "https://mail.example.com/api/domains" \
  --header "Authorization: Bearer om_at_..."

GET /api/mailboxes

列出当前用户邮箱 / List current-user mailboxes

返回当前用户可见的邮箱地址、主邮箱和启用状态。

Return visible mailbox addresses, the primary mailbox, and active state.

cURL 示例

curl --request GET \
  --url "https://mail.example.com/api/mailboxes" \
  --header "Authorization: Bearer om_at_..."

POST /api/mailboxes

创建邮箱地址 / Create a mailbox address

在启用域名下创建地址；受角色权限、邮箱上限和地址规则限制。

Create an address on an active domain, subject to role, quota, and address rules.

cURL 示例

curl --request POST \
  --url "https://mail.example.com/api/mailboxes" \
  --header "Authorization: Bearer om_at_..." \
  --header "Content-Type: application/json" \
  --data '{
  "address": "owner@example.com"
}'

PATCH /api/mailboxes/{address}

启停邮箱或设为主邮箱 / Enable, disable, or make a mailbox primary

更新拥有的邮箱地址；停用或设主地址时会执行安全约束。

Update an owned mailbox while enforcing disable and primary-address safeguards.

cURL 示例

curl --request PATCH \
  --url "https://mail.example.com/api/mailboxes/owner%40example.com" \
  --header "Authorization: Bearer om_at_..." \
  --header "Content-Type: application/json" \
  --data '{
  "isPrimary": true
}'

DELETE /api/mailboxes/{address}

删除非主邮箱 / Delete a non-primary mailbox

立即隐藏非主邮箱，并启动邮件、草稿和附件的异步清理。

Hide a non-primary mailbox immediately and start asynchronous mail, draft, and attachment cleanup.

cURL 示例

curl --request DELETE \
  --url "https://mail.example.com/api/mailboxes/owner%40example.com" \
  --header "Authorization: Bearer om_at_..."