agentmail 0.5.46 → 0.5.48
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/agent/client/Client.d.ts +3 -1
- package/dist/cjs/api/resources/agent/client/Client.js +3 -1
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +4 -4
- package/dist/cjs/api/resources/calendar/types/IanaTimezone.d.ts +5 -3
- package/dist/cjs/api/resources/domains/types/Domain.d.ts +11 -4
- package/dist/cjs/api/resources/domains/types/RecordType.d.ts +1 -0
- package/dist/cjs/api/resources/domains/types/RecordType.js +1 -0
- package/dist/cjs/api/resources/domains/types/TrackingEnabled.d.ts +4 -3
- package/dist/cjs/api/resources/domains/types/TrackingStatus.d.ts +10 -0
- package/dist/cjs/api/resources/domains/types/TrackingStatus.js +3 -0
- package/dist/cjs/api/resources/domains/types/UpdateDomainRequest.d.ts +2 -1
- package/dist/cjs/api/resources/domains/types/VerificationRecord.d.ts +1 -1
- package/dist/cjs/api/resources/domains/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/domains/types/index.js +1 -0
- package/dist/cjs/api/resources/events/types/EventId.d.ts +3 -1
- package/dist/cjs/api/resources/events/types/InboxIds.d.ts +1 -1
- package/dist/cjs/api/resources/events/types/MessageReceivedEvent.d.ts +1 -1
- package/dist/cjs/api/resources/events/types/PodIds.d.ts +1 -1
- package/dist/cjs/api/resources/events/types/ReceivedMessage.d.ts +18 -0
- package/dist/cjs/api/resources/events/types/ReceivedMessage.js +3 -0
- package/dist/cjs/api/resources/events/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/events/types/index.js +1 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/inboxes/client/Client.js +2 -1
- package/dist/cjs/api/resources/inboxes/resources/calendar/client/Client.d.ts +20 -21
- package/dist/cjs/api/resources/inboxes/resources/calendar/client/Client.js +20 -21
- package/dist/cjs/api/resources/inboxes/types/CreateInboxRequest.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/types/Inbox.d.ts +5 -0
- package/dist/cjs/api/resources/inboxes/types/PauseAt.d.ts +7 -0
- package/dist/cjs/api/resources/inboxes/types/PauseAt.js +3 -0
- package/dist/cjs/api/resources/inboxes/types/UpdateInboxRequest.d.ts +7 -1
- package/dist/cjs/api/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/api/resources/messages/types/Message.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationDomain.d.ts +5 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationDomain.js +3 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationResults.d.ts +56 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationResults.js +3 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationVerdict.d.ts +16 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationVerdict.js +19 -0
- package/dist/cjs/api/resources/messages/types/MessageCalendarEventId.d.ts +3 -2
- package/dist/cjs/api/resources/messages/types/MessageHeaders.d.ts +4 -1
- package/dist/cjs/api/resources/messages/types/MessageItem.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/messages/types/index.js +3 -0
- package/dist/cjs/api/resources/metrics/client/Client.d.ts +3 -4
- package/dist/cjs/api/resources/metrics/client/Client.js +3 -4
- package/dist/cjs/api/resources/organizations/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/client/Client.js +1 -1
- package/dist/cjs/api/resources/organizations/types/Organization.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/types/CreatePodWebhookRequest.d.ts +4 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookEventTypes.d.ts +3 -2
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequest.d.ts +3 -2
- package/dist/cjs/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.ts +6 -4
- package/dist/cjs/api/resources/webhooks/types/UpdatePodWebhookRequest.d.ts +2 -1
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookEventTypes.d.ts +2 -2
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequest.d.ts +4 -1
- package/dist/cjs/api/resources/webhooks/types/Webhook.d.ts +5 -1
- package/dist/cjs/serialization/resources/domains/types/Domain.d.ts +3 -0
- package/dist/cjs/serialization/resources/domains/types/Domain.js +3 -0
- package/dist/cjs/serialization/resources/domains/types/RecordType.d.ts +1 -1
- package/dist/cjs/serialization/resources/domains/types/RecordType.js +1 -1
- package/dist/cjs/serialization/resources/domains/types/TrackingStatus.d.ts +8 -0
- package/dist/cjs/serialization/resources/domains/types/TrackingStatus.js +6 -0
- package/dist/cjs/serialization/resources/domains/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/domains/types/index.js +1 -0
- package/dist/cjs/serialization/resources/events/types/MessageReceivedEvent.d.ts +2 -2
- package/dist/cjs/serialization/resources/events/types/MessageReceivedEvent.js +2 -2
- package/dist/cjs/serialization/resources/events/types/ReceivedMessage.d.ts +11 -0
- package/dist/cjs/serialization/resources/events/types/ReceivedMessage.js +45 -0
- package/dist/cjs/serialization/resources/events/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/events/types/index.js +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/Inbox.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/Inbox.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/PauseAt.d.ts +7 -0
- package/dist/cjs/serialization/resources/inboxes/types/PauseAt.js +39 -0
- package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/serialization/resources/messages/types/Message.d.ts +2 -0
- package/dist/cjs/serialization/resources/messages/types/Message.js +2 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationDomain.d.ts +7 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationDomain.js +39 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationResults.d.ts +17 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationResults.js +49 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationVerdict.d.ts +7 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationVerdict.js +39 -0
- package/dist/cjs/serialization/resources/messages/types/MessageItem.d.ts +2 -0
- package/dist/cjs/serialization/resources/messages/types/MessageItem.js +2 -0
- package/dist/cjs/serialization/resources/messages/types/index.d.ts +3 -0
- package/dist/cjs/serialization/resources/messages/types/index.js +3 -0
- package/dist/cjs/serialization/resources/organizations/types/Organization.d.ts +2 -0
- package/dist/cjs/serialization/resources/organizations/types/Organization.js +2 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/agent/client/Client.d.mts +3 -1
- package/dist/esm/api/resources/agent/client/Client.mjs +3 -1
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +4 -4
- package/dist/esm/api/resources/calendar/types/IanaTimezone.d.mts +5 -3
- package/dist/esm/api/resources/domains/types/Domain.d.mts +11 -4
- package/dist/esm/api/resources/domains/types/RecordType.d.mts +1 -0
- package/dist/esm/api/resources/domains/types/RecordType.mjs +1 -0
- package/dist/esm/api/resources/domains/types/TrackingEnabled.d.mts +4 -3
- package/dist/esm/api/resources/domains/types/TrackingStatus.d.mts +10 -0
- package/dist/esm/api/resources/domains/types/TrackingStatus.mjs +2 -0
- package/dist/esm/api/resources/domains/types/UpdateDomainRequest.d.mts +2 -1
- package/dist/esm/api/resources/domains/types/VerificationRecord.d.mts +1 -1
- package/dist/esm/api/resources/domains/types/index.d.mts +1 -0
- package/dist/esm/api/resources/domains/types/index.mjs +1 -0
- package/dist/esm/api/resources/events/types/EventId.d.mts +3 -1
- package/dist/esm/api/resources/events/types/InboxIds.d.mts +1 -1
- package/dist/esm/api/resources/events/types/MessageReceivedEvent.d.mts +1 -1
- package/dist/esm/api/resources/events/types/PodIds.d.mts +1 -1
- package/dist/esm/api/resources/events/types/ReceivedMessage.d.mts +18 -0
- package/dist/esm/api/resources/events/types/ReceivedMessage.mjs +2 -0
- package/dist/esm/api/resources/events/types/index.d.mts +1 -0
- package/dist/esm/api/resources/events/types/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/inboxes/client/Client.mjs +2 -1
- package/dist/esm/api/resources/inboxes/resources/calendar/client/Client.d.mts +20 -21
- package/dist/esm/api/resources/inboxes/resources/calendar/client/Client.mjs +20 -21
- package/dist/esm/api/resources/inboxes/types/CreateInboxRequest.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/types/Inbox.d.mts +5 -0
- package/dist/esm/api/resources/inboxes/types/PauseAt.d.mts +7 -0
- package/dist/esm/api/resources/inboxes/types/PauseAt.mjs +2 -0
- package/dist/esm/api/resources/inboxes/types/UpdateInboxRequest.d.mts +7 -1
- package/dist/esm/api/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/api/resources/messages/types/Message.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationDomain.d.mts +5 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationDomain.mjs +2 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationResults.d.mts +56 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationResults.mjs +2 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationVerdict.d.mts +16 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationVerdict.mjs +16 -0
- package/dist/esm/api/resources/messages/types/MessageCalendarEventId.d.mts +3 -2
- package/dist/esm/api/resources/messages/types/MessageHeaders.d.mts +4 -1
- package/dist/esm/api/resources/messages/types/MessageItem.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/index.d.mts +3 -0
- package/dist/esm/api/resources/messages/types/index.mjs +3 -0
- package/dist/esm/api/resources/metrics/client/Client.d.mts +3 -4
- package/dist/esm/api/resources/metrics/client/Client.mjs +3 -4
- package/dist/esm/api/resources/organizations/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/organizations/client/Client.mjs +1 -1
- package/dist/esm/api/resources/organizations/types/Organization.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/types/CreatePodWebhookRequest.d.mts +4 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookEventTypes.d.mts +3 -2
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequest.d.mts +3 -2
- package/dist/esm/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.mts +6 -4
- package/dist/esm/api/resources/webhooks/types/UpdatePodWebhookRequest.d.mts +2 -1
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookEventTypes.d.mts +2 -2
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequest.d.mts +4 -1
- package/dist/esm/api/resources/webhooks/types/Webhook.d.mts +5 -1
- package/dist/esm/serialization/resources/domains/types/Domain.d.mts +3 -0
- package/dist/esm/serialization/resources/domains/types/Domain.mjs +3 -0
- package/dist/esm/serialization/resources/domains/types/RecordType.d.mts +1 -1
- package/dist/esm/serialization/resources/domains/types/RecordType.mjs +1 -1
- package/dist/esm/serialization/resources/domains/types/TrackingStatus.d.mts +8 -0
- package/dist/esm/serialization/resources/domains/types/TrackingStatus.mjs +3 -0
- package/dist/esm/serialization/resources/domains/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/domains/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/events/types/MessageReceivedEvent.d.mts +2 -2
- package/dist/esm/serialization/resources/events/types/MessageReceivedEvent.mjs +2 -2
- package/dist/esm/serialization/resources/events/types/ReceivedMessage.d.mts +11 -0
- package/dist/esm/serialization/resources/events/types/ReceivedMessage.mjs +9 -0
- package/dist/esm/serialization/resources/events/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/events/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/Inbox.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/Inbox.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/PauseAt.d.mts +7 -0
- package/dist/esm/serialization/resources/inboxes/types/PauseAt.mjs +3 -0
- package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/messages/types/Message.d.mts +2 -0
- package/dist/esm/serialization/resources/messages/types/Message.mjs +2 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationDomain.d.mts +7 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationDomain.mjs +3 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationResults.d.mts +17 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationResults.mjs +13 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationVerdict.d.mts +7 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationVerdict.mjs +3 -0
- package/dist/esm/serialization/resources/messages/types/MessageItem.d.mts +2 -0
- package/dist/esm/serialization/resources/messages/types/MessageItem.mjs +2 -0
- package/dist/esm/serialization/resources/messages/types/index.d.mts +3 -0
- package/dist/esm/serialization/resources/messages/types/index.mjs +3 -0
- package/dist/esm/serialization/resources/organizations/types/Organization.d.mts +2 -0
- package/dist/esm/serialization/resources/organizations/types/Organization.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms.txt +20 -2
- package/package.json +3 -2
- package/reference.md +29 -28
package/dist/llms.txt
CHANGED
|
@@ -36,6 +36,9 @@
|
|
|
36
36
|
- [CLI](https://docs.agentmail.to/integrations/cli.md): AgentMail's official command-line interface
|
|
37
37
|
- [Google ADK](https://docs.agentmail.to/integrations/google-adk.md): AgentMail's Google Agent Development Kit (ADK) integration
|
|
38
38
|
- [LangChain](https://docs.agentmail.to/integrations/langchain.md): AgentMail's LangChain integration
|
|
39
|
+
- [Vercel AI SDK](https://docs.agentmail.to/integrations/ai-sdk.md): Give a Vercel AI SDK agent its own email inbox. The agentmail-toolkit package exposes the AgentMail API as AI SDK tools for generateText, streamText, and ToolLoopAgent.
|
|
40
|
+
- [OpenAI Agents SDK](https://docs.agentmail.to/integrations/openai-agents-sdk.md): Give an OpenAI Agents SDK agent its own email address. The agentmail-toolkit Python package exposes the AgentMail API as OpenAI Agents SDK tools.
|
|
41
|
+
- [Claude Agent SDK](https://docs.agentmail.to/integrations/claude-agent-sdk.md): Give a Claude Agent SDK agent its own email inbox by connecting it to the hosted AgentMail MCP server. No extra packages to install.
|
|
39
42
|
- [OpenClaw](https://docs.agentmail.to/integrations/openclaw.md): Install AgentMail as an official OpenClaw plugin with one command. Your agent gets its own inbox plus an allowlisted email channel it can be reached at.
|
|
40
43
|
- [Grok Bot](https://docs.agentmail.to/integrations/grokbot.md): AgentMail's Grok Bot, Grok Build, and Grok API integration
|
|
41
44
|
- [Replit](https://docs.agentmail.to/integrations/replit.md): AgentMail's Replit integration
|
|
@@ -78,23 +81,30 @@
|
|
|
78
81
|
- [Spam & Virus Detection](https://docs.agentmail.to/spam-virus-detection.md): How AgentMail automatically scans incoming emails for spam and viruses.
|
|
79
82
|
- [API Welcome](https://docs.agentmail.to/api-reference.md): Quick overview of the AgentMail SDK
|
|
80
83
|
- [Knowledge Base](https://docs.agentmail.to/knowledge-base.md): A collection of answers to frequently asked questions.
|
|
81
|
-
- [What is AgentMail and how is it different?](https://docs.agentmail.to/knowledge-base/what-is-agentmail.md): Understand
|
|
84
|
+
- [What is AgentMail and how is it different?](https://docs.agentmail.to/knowledge-base/what-is-agentmail.md): Understand what AgentMail gives an AI agent and when to use it.
|
|
82
85
|
- [What can I do with an AgentMail inbox?](https://docs.agentmail.to/knowledge-base/inbox-capabilities.md): A complete overview of inbox capabilities for AI agents.
|
|
83
86
|
- [Can I set a profile picture for my inbox?](https://docs.agentmail.to/knowledge-base/inbox-profile-pictures.md): Learn how to associate a Google profile picture with an AgentMail address, how BIMI logos differ, and when Gmail requires a VMC or CMC certificate.
|
|
84
87
|
- [How do I create my first inbox?](https://docs.agentmail.to/knowledge-base/creating-first-inbox.md): Get up and running with your first AgentMail inbox.
|
|
85
88
|
- [How do I get my API key?](https://docs.agentmail.to/knowledge-base/getting-api-key.md): Create and manage your AgentMail API keys.
|
|
86
89
|
- [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox.md): Take ownership of an inbox your agent created without your email.
|
|
87
|
-
- [
|
|
90
|
+
- [Why can my agent only email its human?](https://docs.agentmail.to/knowledge-base/agent-sign-up-limits.md): The limits on an account an agent created for itself, the errors it sees, and how verification lifts them.
|
|
91
|
+
- [Why was my account suspended?](https://docs.agentmail.to/knowledge-base/account-suspended.md): What each suspension reason means, what still works while suspended, and how to get a review.
|
|
92
|
+
- [How do I upgrade, downgrade, or cancel my plan?](https://docs.agentmail.to/knowledge-base/change-plan-billing.md): Change your plan, manage payment methods and invoices, or cancel from the AgentMail Console.
|
|
93
|
+
- [Security and compliance FAQ](https://docs.agentmail.to/knowledge-base/security-compliance.md): SOC 2, subprocessors, privacy, data residency, retention, email authentication, and where to send other questions.
|
|
94
|
+
- [How do I handle inbound emails with my agent?](https://docs.agentmail.to/knowledge-base/handling-inbound-emails.md): Compare webhooks, WebSockets, and polling webhooks for processing incoming emails.
|
|
88
95
|
- [How do I set up allowlists and blocklists?](https://docs.agentmail.to/knowledge-base/allowlists-blocklists.md): Control who your AI agent can send to and receive from.
|
|
89
96
|
- [How do I manage threaded conversations?](https://docs.agentmail.to/knowledge-base/threaded-conversations.md): Maintain context across multi-turn email conversations with your agent.
|
|
90
97
|
- [How do I build a human-in-the-loop workflow?](https://docs.agentmail.to/knowledge-base/human-in-the-loop.md): Keep humans in control of your agent's email communications.
|
|
91
98
|
- [How do I use Pods for multi-tenant email?](https://docs.agentmail.to/knowledge-base/pods-multi-tenant.md): Isolate inboxes, domains, and data across tenants with Pods.
|
|
92
99
|
- [How do I use labels to track email state?](https://docs.agentmail.to/knowledge-base/labels-track-state.md): Use labels to manage agent workflow state on emails and threads.
|
|
100
|
+
- [How do I know when an email is opened?](https://docs.agentmail.to/knowledge-base/open-tracking.md): Track opens on the emails your agent sends, and react when a recipient reads one.
|
|
93
101
|
- [How do I set up a custom domain?](https://docs.agentmail.to/knowledge-base/custom-domain-setup.md): Send emails from your own domain instead of @agentmail.to.
|
|
102
|
+
- [How do I create inboxes on any subdomain?](https://docs.agentmail.to/knowledge-base/subdomain-inboxes.md): Register one parent domain and use it for inboxes across its subdomains.
|
|
94
103
|
- [How do I set up SPF, DKIM, and DMARC?](https://docs.agentmail.to/knowledge-base/spf-dkim-dmarc.md): Authenticate your domain for reliable email deliverability.
|
|
95
104
|
- [Why are my emails going to spam?](https://docs.agentmail.to/knowledge-base/emails-going-to-spam.md): Troubleshoot and fix spam folder placement issues.
|
|
96
105
|
- [Warming Up](https://docs.agentmail.to/knowledge-base/domain-warming.md): Gradually build sending reputation on a new domain or inbox.
|
|
97
106
|
- [How do I avoid MX record conflicts?](https://docs.agentmail.to/knowledge-base/mx-record-conflicts.md): Add AgentMail DNS records without breaking existing email.
|
|
107
|
+
- [Can my agent send cold outreach?](https://docs.agentmail.to/knowledge-base/cold-outreach.md): AgentMail does not support cold outreach. Here is what it is built for, and how to handle opt-outs.
|
|
98
108
|
- [What does a 403 error mean?](https://docs.agentmail.to/knowledge-base/api-403-error.md): Common causes of API 403 Forbidden errors and how to fix them.
|
|
99
109
|
- [What are the rate limits?](https://docs.agentmail.to/knowledge-base/rate-limits.md): Understand AgentMail's sending limits and API rate limits, and how to work within them.
|
|
100
110
|
- [How do I prevent duplicate sends?](https://docs.agentmail.to/knowledge-base/preventing-duplicate-sends.md): Use idempotency to avoid sending the same email twice.
|
|
@@ -113,6 +123,11 @@
|
|
|
113
123
|
- API Reference > Agent [Sign Up](https://docs.agentmail.to/api-reference/agent/sign-up.md)
|
|
114
124
|
- API Reference > Agent [Attach Human](https://docs.agentmail.to/api-reference/agent/attach-human.md)
|
|
115
125
|
- API Reference > Agent [Verify](https://docs.agentmail.to/api-reference/agent/verify.md)
|
|
126
|
+
- API Reference > Inboxes > Files [Create File](https://docs.agentmail.to/api-reference/inboxes/files/create.md)
|
|
127
|
+
- API Reference > Inboxes > Files [Complete File](https://docs.agentmail.to/api-reference/inboxes/files/complete.md)
|
|
128
|
+
- API Reference > Inboxes > Files [Get File](https://docs.agentmail.to/api-reference/inboxes/files/get.md)
|
|
129
|
+
- API Reference > Inboxes > Files [List Files](https://docs.agentmail.to/api-reference/inboxes/files/list.md)
|
|
130
|
+
- API Reference > Inboxes > Files [Delete File](https://docs.agentmail.to/api-reference/inboxes/files/delete.md)
|
|
116
131
|
- API Reference > Inboxes [List Inboxes](https://docs.agentmail.to/api-reference/inboxes/list.md)
|
|
117
132
|
- API Reference > Inboxes [Search Inboxes](https://docs.agentmail.to/api-reference/inboxes/search.md)
|
|
118
133
|
- API Reference > Inboxes [Get Inbox](https://docs.agentmail.to/api-reference/inboxes/get.md)
|
|
@@ -130,6 +145,7 @@
|
|
|
130
145
|
- API Reference > Inboxes > Messages [Search Messages](https://docs.agentmail.to/api-reference/inboxes/messages/search.md)
|
|
131
146
|
- API Reference > Inboxes > Messages [Get Message](https://docs.agentmail.to/api-reference/inboxes/messages/get.md)
|
|
132
147
|
- API Reference > Inboxes > Messages [Create Agent Armor Feedback](https://docs.agentmail.to/api-reference/inboxes/messages/create-agent-armor-feedback.md)
|
|
148
|
+
- API Reference > Inboxes > Messages [Release Agent Armor Message](https://docs.agentmail.to/api-reference/inboxes/messages/release-agent-armor-message.md)
|
|
133
149
|
- API Reference > Inboxes > Messages [Batch Get Messages](https://docs.agentmail.to/api-reference/inboxes/messages/batch-get.md)
|
|
134
150
|
- API Reference > Inboxes > Messages [Batch Update Messages](https://docs.agentmail.to/api-reference/inboxes/messages/batch-update.md)
|
|
135
151
|
- API Reference > Inboxes > Messages [Get Attachment](https://docs.agentmail.to/api-reference/inboxes/messages/get-attachment.md)
|
|
@@ -200,6 +216,8 @@
|
|
|
200
216
|
- API Reference > Webhooks [Delete Webhook](https://docs.agentmail.to/api-reference/webhooks/delete.md)
|
|
201
217
|
- API Reference > Webhooks > Events [Message Received](https://docs.agentmail.to/api-reference/webhooks/events/message-received.md)
|
|
202
218
|
- API Reference > Webhooks > Events [Message Security Completed](https://docs.agentmail.to/api-reference/webhooks/events/message-security-completed.md)
|
|
219
|
+
- API Reference > Webhooks > Events [Message Security Review](https://docs.agentmail.to/api-reference/webhooks/events/message-security-review.md)
|
|
220
|
+
- API Reference > Webhooks > Events [Message Security Override](https://docs.agentmail.to/api-reference/webhooks/events/message-security-override.md)
|
|
203
221
|
- API Reference > Webhooks > Events [Message Sent](https://docs.agentmail.to/api-reference/webhooks/events/message-sent.md)
|
|
204
222
|
- API Reference > Webhooks > Events [Message Delivered](https://docs.agentmail.to/api-reference/webhooks/events/message-delivered.md)
|
|
205
223
|
- API Reference > Webhooks > Events [Message Bounced](https://docs.agentmail.to/api-reference/webhooks/events/message-bounced.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agentmail",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.48",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -511,7 +511,8 @@
|
|
|
511
511
|
"pnpm": {
|
|
512
512
|
"overrides": {
|
|
513
513
|
"postcss": ">=8.5.23",
|
|
514
|
-
"fast-uri": ">=3.1.5"
|
|
514
|
+
"fast-uri": ">=3.1.5",
|
|
515
|
+
"browserslist": ">=4.28.7"
|
|
515
516
|
}
|
|
516
517
|
},
|
|
517
518
|
"description": "The email inbox API for AI agents. Send, receive, reply, and manage threaded email conversations programmatically.",
|
package/reference.md
CHANGED
|
@@ -286,7 +286,8 @@ agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
|
|
|
286
286
|
```
|
|
287
287
|
|
|
288
288
|
To pause an inbox, set `status` to `paused`; set it back to `active` to
|
|
289
|
-
resume.
|
|
289
|
+
resume. To pause it later, set `pause_at`. See
|
|
290
|
+
[Pausing an inbox](/inboxes#pausing-an-inbox).
|
|
290
291
|
</dd>
|
|
291
292
|
</dl>
|
|
292
293
|
</dd>
|
|
@@ -1468,6 +1469,8 @@ Create a new agent organization with an inbox and API key. This endpoint is for
|
|
|
1468
1469
|
|
|
1469
1470
|
A 6-digit OTP is sent to the human's email for verification.
|
|
1470
1471
|
|
|
1472
|
+
The new organization starts with 1 inbox, no custom domains, and 10 emails per day, which can be sent only to `human_email` until the organization is verified.
|
|
1473
|
+
|
|
1471
1474
|
`human_email` is optional. Without it, the inbox can receive email but cannot send to anyone until a human is attached with the attach human endpoint or, for a US-region inbox, claims it in the AgentMail Console with the API key (see [How do I claim my agent's inbox?](https://docs.agentmail.to/knowledge-base/claiming-agent-inbox)). There is also no way to recover the API key, so store it durably. Calling sign-up again without `human_email` creates a new organization, which needs a different `username`: the original username stays with the lost organization's inbox.
|
|
1472
1475
|
|
|
1473
1476
|
This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
@@ -1622,7 +1625,7 @@ await client.agent.attachHuman({
|
|
|
1622
1625
|
|
|
1623
1626
|
Verify an agent organization using the 6-digit OTP sent to the human's email during sign-up.
|
|
1624
1627
|
|
|
1625
|
-
On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and
|
|
1628
|
+
On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and the Free plan's entitlements are applied: 3 inboxes and 100 emails per day, at first to at most 3 distinct recipients in the first hour, 5 in the first day, and 10 in the first week.
|
|
1626
1629
|
|
|
1627
1630
|
The OTP expires after 24 hours and allows a maximum of 10 attempts. If the OTP expired, call the attach human endpoint with the same `human_email` to get a new one without rotating the API key. Once all 10 attempts are used, even the correct OTP is rejected, and attach human keeps returning the same OTP until it expires, so wait for it to expire before asking for a new one. An organization that signed up without a `human_email` has no OTP until a human is attached. If you run into any difficulties receiving the OTP code, you can also create an account on [console.agentmail.to](https://console.agentmail.to) using the human email address you provided to verify your account.
|
|
1628
1631
|
|
|
@@ -3643,9 +3646,8 @@ Gets the inbox's calendar. Every inbox has one calendar, so this works before an
|
|
|
3643
3646
|
created. Its `etag` (also the `ETag` response header) is the value to send in `If-Match` to
|
|
3644
3647
|
make an update conditional.
|
|
3645
3648
|
|
|
3646
|
-
Requires the `calendar_read` permission. Calendar is
|
|
3647
|
-
but not yet in EU production (`api.agentmail.eu`)
|
|
3648
|
-
Labs receive a `403`.
|
|
3649
|
+
Requires the `calendar_read` permission. Calendar is available in US production
|
|
3650
|
+
(`api.agentmail.to`) but not yet in EU production (`api.agentmail.eu`), which returns `403`.
|
|
3649
3651
|
</dd>
|
|
3650
3652
|
</dl>
|
|
3651
3653
|
</dd>
|
|
@@ -3723,8 +3725,8 @@ Requires the `calendar_update` permission. To make the update conditional, send
|
|
|
3723
3725
|
calendar's current `etag` in `If-Match`: a stale value returns `412`. Without `If-Match` the
|
|
3724
3726
|
update applies to the calendar as it is.
|
|
3725
3727
|
|
|
3726
|
-
Calendar is
|
|
3727
|
-
|
|
3728
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
3729
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
3728
3730
|
</dd>
|
|
3729
3731
|
</dl>
|
|
3730
3732
|
</dd>
|
|
@@ -3806,8 +3808,8 @@ use Get Agenda.
|
|
|
3806
3808
|
The list is always read in the region that serves the request, so it can trail a change made
|
|
3807
3809
|
moments earlier by a few seconds. Requires the `calendar_event_read` permission.
|
|
3808
3810
|
|
|
3809
|
-
Calendar is
|
|
3810
|
-
|
|
3811
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
3812
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
3811
3813
|
</dd>
|
|
3812
3814
|
</dl>
|
|
3813
3815
|
</dd>
|
|
@@ -3897,8 +3899,8 @@ The agenda is read in the region that serves the request, so it can trail a chan
|
|
|
3897
3899
|
moments earlier by a few seconds. Pass `consistency=primary` to read your own change right
|
|
3898
3900
|
away. Requires the `calendar_event_read` permission.
|
|
3899
3901
|
|
|
3900
|
-
Calendar is
|
|
3901
|
-
|
|
3902
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
3903
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
3902
3904
|
</dd>
|
|
3903
3905
|
</dl>
|
|
3904
3906
|
</dd>
|
|
@@ -3993,8 +3995,8 @@ charged again.
|
|
|
3993
3995
|
The event's `etag` is the value to send in `If-Match` to make a later update or delete
|
|
3994
3996
|
conditional. Requires the `calendar_event_create` permission.
|
|
3995
3997
|
|
|
3996
|
-
Calendar is
|
|
3997
|
-
|
|
3998
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
3999
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
3998
4000
|
</dd>
|
|
3999
4001
|
</dl>
|
|
4000
4002
|
</dd>
|
|
@@ -4093,8 +4095,8 @@ to read the latest state of an event or a date. A date that has already started
|
|
|
4093
4095
|
reads back as it ran, even if a later change to the series no longer produces it. Requires
|
|
4094
4096
|
the `calendar_event_read` permission.
|
|
4095
4097
|
|
|
4096
|
-
Calendar is
|
|
4097
|
-
|
|
4098
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
4099
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
4098
4100
|
</dd>
|
|
4099
4101
|
</dl>
|
|
4100
4102
|
</dd>
|
|
@@ -4198,8 +4200,8 @@ Emailing attendees counts one send per attendee against the organization, pod an
|
|
|
4198
4200
|
send limits, charged before the change is saved; an over-limit request returns `429`
|
|
4199
4201
|
`rate_limit_exceeded` and changes nothing.
|
|
4200
4202
|
|
|
4201
|
-
Calendar is
|
|
4202
|
-
|
|
4203
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
4204
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
4203
4205
|
</dd>
|
|
4204
4206
|
</dl>
|
|
4205
4207
|
</dd>
|
|
@@ -4304,8 +4306,8 @@ Emailing cancellations counts one send per attendee against the organization, po
|
|
|
4304
4306
|
send limits, charged before the delete; an over-limit request returns `429`
|
|
4305
4307
|
`rate_limit_exceeded` and deletes nothing.
|
|
4306
4308
|
|
|
4307
|
-
Calendar is
|
|
4308
|
-
|
|
4309
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
4310
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
4309
4311
|
</dd>
|
|
4310
4312
|
</dl>
|
|
4311
4313
|
</dd>
|
|
@@ -4396,8 +4398,8 @@ and `attendees`; get a date by its ID for the full object. Like other reads, the
|
|
|
4396
4398
|
trail a change made moments earlier by a few seconds; pass `consistency=primary` to read
|
|
4397
4399
|
your own change right away. Requires the `calendar_event_read` permission.
|
|
4398
4400
|
|
|
4399
|
-
Calendar is
|
|
4400
|
-
|
|
4401
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
4402
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
4401
4403
|
</dd>
|
|
4402
4404
|
</dl>
|
|
4403
4405
|
</dd>
|
|
@@ -4494,8 +4496,8 @@ A reply email counts as one send against the organization, pod and inbox send li
|
|
|
4494
4496
|
charged before the response is saved; an over-limit request returns `429`
|
|
4495
4497
|
`rate_limit_exceeded` and changes nothing.
|
|
4496
4498
|
|
|
4497
|
-
Calendar is
|
|
4498
|
-
|
|
4499
|
+
Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
4500
|
+
(`api.agentmail.eu`), which returns `403`.
|
|
4499
4501
|
</dd>
|
|
4500
4502
|
</dl>
|
|
4501
4503
|
</dd>
|
|
@@ -9208,10 +9210,9 @@ Rolling bounce and complaint rates for the organization. At each
|
|
|
9208
9210
|
`period` grid point, the bounced (or complained) messages over the
|
|
9209
9211
|
preceding `window` divided by the messages sent over the same window,
|
|
9210
9212
|
with the send count alongside so you can see the volume behind
|
|
9211
|
-
it.
|
|
9212
|
-
|
|
9213
|
-
|
|
9214
|
-
window. Defaults to the rolling 24-hour rate sampled hourly over the
|
|
9213
|
+
it. AgentMail weighs bounce and complaint signals when deciding
|
|
9214
|
+
whether to suspend an account's sending, so keep both rates low.
|
|
9215
|
+
Defaults to the rolling 24-hour rate sampled hourly over the
|
|
9215
9216
|
last day; `start` must be within the last 90 days, `window` must be a
|
|
9216
9217
|
whole multiple of `period`, and the range plus window divided by
|
|
9217
9218
|
`period` must not exceed 1000 buckets.
|
|
@@ -9343,7 +9344,7 @@ await client.organizations.get();
|
|
|
9343
9344
|
<dl>
|
|
9344
9345
|
<dd>
|
|
9345
9346
|
|
|
9346
|
-
Returns whether the organization is in
|
|
9347
|
+
Returns whether the organization is in AgentMail Labs, which turns on features that are still in preview, such as [Agent Armor](https://docs.agentmail.to/agent-armor). Requires an organization-scoped API key.
|
|
9347
9348
|
|
|
9348
9349
|
**CLI:**
|
|
9349
9350
|
```bash
|