运维手册

API请求超时了,邮箱到底创建成功了吗?

作者:Alexey Bulygin
绿色信箱前摆着放大镜,旁边是一只沙漏

请求超时并不能说明创建失败。你的系统需要把客户申请与最终邮箱关联起来。把创建邮箱、设置转发和确认可用分成不同步骤,连接中断后,用户就不必在不知结果的情况下再次点击创建。

可以让程序通过 TrekMail API 创建邮箱和设置转发。API 允许你的系统向服务发送指定命令,不必每次由人在后台手动操作。这些修改需要 Pro 或 Agency、相应权限,以及目标域名的访问权。

明确究竟要创建什么

先用普通语言描述需求。“员工需要个人工作邮箱”和“公共地址收到的邮件应送到另一个邮箱”,需要不同配置。

完整邮箱保存自己的通信,可以设置转发,并决定是否保留本地副本。没有邮箱的纯转发地址则适合只接收后转交、不在该地址保留独立邮件存档的情况。两种方式的条件和限制不同。

还要区分邮件系统管理与邮件内容访问。创建地址并不自动需要阅读员工通信,消息内容属于 API 的另一组能力。只负责创建邮箱的程序,不应获得这些内容权限。

开发前写清这些区别,开发者就能理解要创建哪种资源,以及你期待在后台看到什么结果。

准备套餐和有限权限

能在界面中手动配置某项功能,不一定意味着能通过 API 修改。创建邮箱和调整转发需要 Pro 或 Agency。Starter 允许读取可访问的基础设施配置,但不足以完成这种自动化。

为程序创建独立访问,仅开放所需动作和域名。代理商服务多家公司时,针对某客户的程序应只操作该客户资源。

授权人的权限也有影响,他不能给程序自己没有的权利。权限和套餐边界见 API 权限参考。

访问密钥保存在集成的服务端设置中,不应展示在客户注册表单,或放进欢迎邮件。用户只需要看到明确结果:已创建的地址,以及规定的开始使用方式。

设计创建顺序

从自己保存的客户关系中确定允许的域名。浏览器传来的域名ID,本身不能证明客户有权操作。

然后检查地址是否存在、额度是否足够。如果邮箱已经创建,先确认是否属于同一次申请。员工重复点击按钮,不应让系统进入难以判断的状态。

创建完成后,按任务设置转发。完整邮箱的转发是否保留本地副本,应提前决定。如果员工希望在那里保留存档,就不能让它取决于偶然的默认值。

如果邮箱已存在但转发失败,记录部分成功的状态,只修复未完成的步骤。检查投递和本地副本后,再向用户显示可用。

具体方法和请求格式见 TrekMail API 概览。开发者按这些规范实现,面向用户的流程仍保持简单。

处理重试和错误

对于文档标明支持幂等的操作,同一申请、同一内容保留相同的Idempotency-Key。保存返回的邮箱ID;其他操作要另查重试规则。

其他情况下,集成应先检查资源是否已经存在。不能遇到任何不明确响应就盲目重复创建地址。保存申请与结果的对应关系,才能从正确步骤继续。

空间不足、额度用尽和访问被拒绝要分别处理。重复同一个请求不能解决这些原因。与一直显示“正在创建邮箱”相比,用户更需要清楚的原因和负责修复的人。

批量接入时,不要承诺所有申请同时完成。显示每一项的状态,并列出需要处理的情况更合适。

先在一个域名上验证流程

从测试域名和几个地址开始,检查正常创建、同一申请重复执行,以及尝试访问授权范围之外的域名。

再向创建的地址发信。如果有转发,检查最终收件人,并按所选模式核对本地副本。API 返回成功并不能代替真实邮件流程测试。

上线前,约定谁会看到错误,并能手动修复。保留不含密钥和密码的申请日志。这个小流程稳定后,再用于员工或客户接入。

以API概览作为实现依据。创建基础设施不要求读取新用户的邮件,只授予这项任务需要的权限。

相关阅读

分享这篇文章

登录 TrekMail

访问您的控制面板、邮箱和 DNS。

12 个字符

重置邮件已发送

如果该邮箱对应已有账户,我们已发送密码重置说明。

继续即表示您同意 TrekMail 的 服务条款 和 隐私政策.