IM
ZH-CN
文档首页
菜单
指南

提供商凭证和连接

注册 IMAP/SMTP 凭据、验证连接并维护凭据生命周期。

inbox-manager client-flow

提供商凭证和连接

目的:注册 IMAP/SMTP 凭据、验证连接并维护凭据生命周期。

用户界面流程

  1. 用户输入 IMAP 和 SMTP 主机/端口/安全模式和秘密值。
  2. UI 使用POST /api/accounts/:account_id/provider-credentials 创建凭证。
  3. UI 立即使用POST /api/provider-credentials/:provider_credential_id/test 进行验证。
  4. UI 列出凭据和验证状态。
  5. UI 支持旋转 (/rotate) 和删除以确保凭证卫生。

客户端库流程

const imapCredential = await api.credentials.create(accountId, {
  provider_kind: "imap",
  label: "Work IMAP",
  host: "mail.example.com",
  port: 993,
  security_mode: "ssl_tls",
  auth_kind: "password",
  secret: { username, password },
});
await api.credentials.test(imapCredential.data.id);

HTTP/curl 流程

API_BASE_URL="https://api.inbox-manager.com"

curl -sS -X POST "${API_BASE_URL}/api/accounts/${ACCOUNT_ID}/provider-credentials" \
  -H "authorization: Bearer ${BEARER_TOKEN}" \
  -H "content-type: application/json" \
  --data '{
    "provider_kind":"imap",
    "label":"Work IMAP",
    "host":"mail.example.com",
    "port":993,
    "security_mode":"ssl_tls",
    "auth_kind":"password",
    "secret":{"username":"user@example.com","password":"***"}
  }'

curl -sS -X POST "${API_BASE_URL}/api/provider-credentials/${PROVIDER_CREDENTIAL_ID}/test" \
  -H "authorization: Bearer ${BEARER_TOKEN}"

curl -sS -X POST "${API_BASE_URL}/api/provider-credentials/${PROVIDER_CREDENTIAL_ID}/rotate" \
  -H "authorization: Bearer ${BEARER_TOKEN}" \
  -H "content-type: application/json" \
  --data '{"secret":{"username":"user@example.com","password":"***"}}'

验证脚本

  • scripts/provider_credentials_flow.sh