客户端流程图
目的:为与api.inbox-manager.com集成的客户端定义预期的顶级序列。
主要流程
- 根据
auth.inbox-manager.com进行身份验证。 - 解决帐户上下文和成员身份。
- 创建并验证 IMAP/SMTP 提供商凭据。
- 将 IMAP 元数据同步到
email_messages。 - 按需阅读消息正文和消息部分。
- 发送出站 SMTP 消息任务。
- 监控和操作作业(触发/重试/解决)。
- 使用任务进行显式排队工作。
- 查看操作日志。
- 管理订阅生命周期操作(所有者)。
端点系列
- 验证:
/auth/*、/oauth2/*、/.well-known/jwks.json - 帐户/成员:
/api/accounts*、/api/accounts/:account_id/members* - 帐户上下文切换:
POST /api/account-views/switch - 凭证:
/api/accounts/:account_id/provider-credentials*、/api/provider-credentials/:provider_credential_id/* - 提供者的行动:-
POST /api/accounts/:account_id/imap/sync-mailboxesPOST /api/accounts/:account_id/imap/sync-messages-POST /api/accounts/:account_id/smtp/messages
- 电子邮件资源:
/api/accounts/:account_id/emails*-/api/emails/:email_id-/api/accounts/:account_id/emails/:email_id/body/api/accounts/:account_id/emails/:email_id/parts-/api/accounts/:account_id/emails/:email_id/parts/:part_id/content
- 任务:
/api/accounts/:account_id/tasks*、/api/tasks/:task_id* - 职位:
/api/accounts/:account_id/jobs*、/api/jobs/:job_id* - 日志:
/api/accounts/:account_id/logs*、/api/logs/:log_id - 订阅:-
/api/subscriptions*-/api/subscriptions/:subscription_id/change-/api/subscriptions/:subscription_id/cancel-/api/subscriptions/stripe/checkout-session/api/subscriptions/stripe/portal-session-/api/subscriptions/stripe/checkout-session-sync
安全期望
- JWT签名验证使用
https://auth.inbox-manager.com/.well-known/jwks.json。 account_id路由路径必须与 JWT 帐户声明匹配。app声明范围包括所有数据访问。- 查看者角色具有读取限制,无法获取正文或部分内容。
- 订阅帐户上下文来自 JWT
acc声明。 auth.inbox-manager.com和api.inbox-manager.com路由在此服务 OpenAPI 之外。