文档
API 文档
将 Mailhook 集成到您的应用所需的一切。
快速入门指南
5 分钟内快速上手 Mailhook。
1. 获取 API 凭据
注册免费账户并生成您的 API 凭据。
- 在 app.mailhook.co 创建账户
- 导航至 设置 → API
- 生成新的 API 密钥
- 妥善保存您的 Agent ID 和 API Key
2. 创建您的第一个邮箱
使用 API 创建一个随机邮箱地址。
curl -X POST https://app.mailhook.co/api/v1/email_addresses/random \
-H "X-Agent-ID: your_agent_id" \
-H "X-API-Key: your_api_key" \
-H "Content-Type: application/json" \
-d '{"domain_id": "your_domain_id"}'
3. 接收邮件
轮询获取收到的邮件,或设置 webhook 获取实时通知。
curl https://app.mailhook.co/api/v1/email_addresses/{id}/inbound_emails \
-H "X-Agent-ID: your_agent_id" \
-H "X-API-Key: your_api_key"
响应示例
{
"data": [
{
"id": "ie_abc123",
"type": "inbound_email",
"attributes": {
"from": "[email protected]",
"subject": "Hello from Mailhook",
"text_body": "Your email content here...",
"received_at": "2025-01-14T12:00:00Z"
}
}
]
}
后续步骤
- 设置 webhook 以获取实时邮件通知
- 添加自定义域名以使用品牌邮箱地址
- 浏览完整的 API 参考以了解所有可用端点
Webhook 设置
配置 webhook 以通过签名载荷实时接收邮件。
Webhook
实时
自定义域名
添加并验证您自己的域名以使用品牌邮箱地址。
域名
DNS
AI 智能体集成
将 Mailhook 与大语言模型智能体和自动化系统集成的最佳实践。
AI
自动化
CI/CD 测试
在测试套件中使用 Mailhook 进行邮件验证流程测试。
测试
CI/CD
速率限制与最佳实践
了解速率限制并优化您的 API 使用。
性能
限制
错误处理
使用正确的错误码和重试逻辑优雅地处理 API 错误。
错误
调试