agentmail 0.5.1 → 0.5.3
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/types/AgentSignupRequest.d.ts +12 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +23 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +80 -0
- package/dist/cjs/api/resources/lists/types/ListEntryBase.d.ts +2 -0
- package/dist/cjs/api/resources/messages/types/BatchGetMessagesMessageIds.d.ts +8 -0
- package/dist/cjs/api/resources/messages/types/BatchGetMessagesMessageIds.js +3 -0
- package/dist/cjs/api/resources/messages/types/BatchGetMessagesRequest.d.ts +4 -0
- package/dist/cjs/api/resources/messages/types/BatchGetMessagesRequest.js +3 -0
- package/dist/cjs/api/resources/messages/types/BatchGetMessagesResponse.d.ts +11 -0
- package/dist/cjs/api/resources/messages/types/BatchGetMessagesResponse.js +3 -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/webhooks/client/Client.d.ts +3 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +3 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequest.d.ts +5 -0
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequest.d.ts +9 -0
- package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/agent/types/AgentSignupRequest.js +2 -0
- package/dist/cjs/serialization/resources/lists/types/ListEntryBase.d.ts +1 -0
- package/dist/cjs/serialization/resources/lists/types/ListEntryBase.js +1 -0
- package/dist/cjs/serialization/resources/messages/types/BatchGetMessagesMessageIds.d.ts +8 -0
- package/dist/cjs/serialization/resources/messages/types/BatchGetMessagesMessageIds.js +40 -0
- package/dist/cjs/serialization/resources/messages/types/BatchGetMessagesRequest.d.ts +10 -0
- package/dist/cjs/serialization/resources/messages/types/BatchGetMessagesRequest.js +42 -0
- package/dist/cjs/serialization/resources/messages/types/BatchGetMessagesResponse.d.ts +14 -0
- package/dist/cjs/serialization/resources/messages/types/BatchGetMessagesResponse.js +46 -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/webhooks/types/UpdateWebhookRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/webhooks/types/UpdateWebhookRequest.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/types/AgentSignupRequest.d.mts +12 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +23 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +80 -0
- package/dist/esm/api/resources/lists/types/ListEntryBase.d.mts +2 -0
- package/dist/esm/api/resources/messages/types/BatchGetMessagesMessageIds.d.mts +8 -0
- package/dist/esm/api/resources/messages/types/BatchGetMessagesMessageIds.mjs +2 -0
- package/dist/esm/api/resources/messages/types/BatchGetMessagesRequest.d.mts +4 -0
- package/dist/esm/api/resources/messages/types/BatchGetMessagesRequest.mjs +2 -0
- package/dist/esm/api/resources/messages/types/BatchGetMessagesResponse.d.mts +11 -0
- package/dist/esm/api/resources/messages/types/BatchGetMessagesResponse.mjs +2 -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/webhooks/client/Client.d.mts +3 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +3 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequest.d.mts +5 -0
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequest.d.mts +9 -0
- package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/agent/types/AgentSignupRequest.mjs +2 -0
- package/dist/esm/serialization/resources/lists/types/ListEntryBase.d.mts +1 -0
- package/dist/esm/serialization/resources/lists/types/ListEntryBase.mjs +1 -0
- package/dist/esm/serialization/resources/messages/types/BatchGetMessagesMessageIds.d.mts +8 -0
- package/dist/esm/serialization/resources/messages/types/BatchGetMessagesMessageIds.mjs +4 -0
- package/dist/esm/serialization/resources/messages/types/BatchGetMessagesRequest.d.mts +10 -0
- package/dist/esm/serialization/resources/messages/types/BatchGetMessagesRequest.mjs +6 -0
- package/dist/esm/serialization/resources/messages/types/BatchGetMessagesResponse.d.mts +14 -0
- package/dist/esm/serialization/resources/messages/types/BatchGetMessagesResponse.mjs +10 -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/webhooks/types/UpdateWebhookRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/webhooks/types/UpdateWebhookRequest.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +6816 -7026
- package/dist/llms.txt +10 -1
- package/package.json +1 -1
- package/reference.md +83 -0
package/dist/llms.txt
CHANGED
|
@@ -2,6 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
> AgentMail is an email API built for AI agents. Create inboxes, send and receive messages, manage threads, and handle webhooks programmatically.
|
|
4
4
|
|
|
5
|
+
## Instructions for AI Agents
|
|
6
|
+
|
|
7
|
+
- For clean Markdown of any page, append `.md` to the page URL
|
|
8
|
+
- For a complete documentation index, see https://docs.agentmail.to/llms.txt
|
|
9
|
+
- For full documentation content in one file, see https://docs.agentmail.to/llms-full.txt
|
|
10
|
+
- For section-specific indexes, append `/llms.txt` to any section URL
|
|
11
|
+
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.agentmail.to/_mcp/server
|
|
12
|
+
|
|
5
13
|
## Docs
|
|
6
14
|
|
|
7
15
|
- [Welcome](https://docs.agentmail.to/welcome.mdx): Your starting point for building with the AgentMail API.
|
|
@@ -18,7 +26,7 @@
|
|
|
18
26
|
- [Permissions](https://docs.agentmail.to/permissions.mdx): Learn how to configure fine-grained permissions on API keys to restrict access to specific resources and operations.
|
|
19
27
|
- [Agent Onboarding](https://docs.agentmail.to/agent-onboarding.mdx): Resources for AI coding assistants, MCP servers, skills, and agent-friendly documentation.
|
|
20
28
|
- [Skills](https://docs.agentmail.to/integrations/skills.mdx): AgentMail's official skill for OpenClaw, Claude Code, Cursor, and other AI assistants
|
|
21
|
-
- [MCP](https://docs.agentmail.to/integrations/mcp.mdx): AgentMail
|
|
29
|
+
- [MCP](https://docs.agentmail.to/integrations/mcp.mdx): Connect AgentMail to Claude, Cursor, and other MCP clients
|
|
22
30
|
- [CLI](https://docs.agentmail.to/integrations/cli.mdx): AgentMail's official command-line interface
|
|
23
31
|
- [Google ADK](https://docs.agentmail.to/integrations/google-adk.mdx): AgentMail's Google Agent Development Kit (ADK) integration
|
|
24
32
|
- [OpenClaw](https://docs.agentmail.to/integrations/openclaw.mdx): AgentMail's OpenClaw integration
|
|
@@ -97,6 +105,7 @@
|
|
|
97
105
|
- API Reference > Inboxes > Threads [Delete Thread](https://docs.agentmail.to/api-reference/inboxes/threads/delete.mdx)
|
|
98
106
|
- API Reference > Inboxes > Messages [List Messages](https://docs.agentmail.to/api-reference/inboxes/messages/list.mdx)
|
|
99
107
|
- API Reference > Inboxes > Messages [Get Message](https://docs.agentmail.to/api-reference/inboxes/messages/get.mdx)
|
|
108
|
+
- API Reference > Inboxes > Messages [Batch Get Messages](https://docs.agentmail.to/api-reference/inboxes/messages/batch-get.mdx)
|
|
100
109
|
- API Reference > Inboxes > Messages [Get Attachment](https://docs.agentmail.to/api-reference/inboxes/messages/get-attachment.mdx)
|
|
101
110
|
- API Reference > Inboxes > Messages [Get Raw Message](https://docs.agentmail.to/api-reference/inboxes/messages/get-raw.mdx)
|
|
102
111
|
- API Reference > Inboxes > Messages [Update Message](https://docs.agentmail.to/api-reference/inboxes/messages/update.mdx)
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -819,6 +819,9 @@ await client.webhooks.create({
|
|
|
819
819
|
<dl>
|
|
820
820
|
<dd>
|
|
821
821
|
|
|
822
|
+
Update inbox or pod subscriptions, or replace the webhook's `event_types` in full when you pass a
|
|
823
|
+
non-empty `event_types` array (see request field docs). Inbox and pod changes use add/remove lists.
|
|
824
|
+
|
|
822
825
|
**CLI:**
|
|
823
826
|
```bash
|
|
824
827
|
agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
|
|
@@ -3330,6 +3333,86 @@ await client.inboxes.messages.get("inbox_id", "message_id");
|
|
|
3330
3333
|
</dl>
|
|
3331
3334
|
|
|
3332
3335
|
|
|
3336
|
+
</dd>
|
|
3337
|
+
</dl>
|
|
3338
|
+
</details>
|
|
3339
|
+
|
|
3340
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">batchGet</a>(inbox_id, { ...params }) -> AgentMail.BatchGetMessagesResponse</code></summary>
|
|
3341
|
+
<dl>
|
|
3342
|
+
<dd>
|
|
3343
|
+
|
|
3344
|
+
#### 📝 Description
|
|
3345
|
+
|
|
3346
|
+
<dl>
|
|
3347
|
+
<dd>
|
|
3348
|
+
|
|
3349
|
+
<dl>
|
|
3350
|
+
<dd>
|
|
3351
|
+
|
|
3352
|
+
Fetch metadata for up to 500 messages in one request. Missing or
|
|
3353
|
+
restricted IDs are silently omitted; compare `count` against `limit`
|
|
3354
|
+
to detect misses.
|
|
3355
|
+
|
|
3356
|
+
**CLI:**
|
|
3357
|
+
```bash
|
|
3358
|
+
agentmail inboxes:messages batch-get --inbox-id <inbox_id> --message-id <id1> --message-id <id2>
|
|
3359
|
+
```
|
|
3360
|
+
</dd>
|
|
3361
|
+
</dl>
|
|
3362
|
+
</dd>
|
|
3363
|
+
</dl>
|
|
3364
|
+
|
|
3365
|
+
#### 🔌 Usage
|
|
3366
|
+
|
|
3367
|
+
<dl>
|
|
3368
|
+
<dd>
|
|
3369
|
+
|
|
3370
|
+
<dl>
|
|
3371
|
+
<dd>
|
|
3372
|
+
|
|
3373
|
+
```typescript
|
|
3374
|
+
await client.inboxes.messages.batchGet("inbox_id", {
|
|
3375
|
+
messageIds: ["message_ids", "message_ids"]
|
|
3376
|
+
});
|
|
3377
|
+
|
|
3378
|
+
```
|
|
3379
|
+
</dd>
|
|
3380
|
+
</dl>
|
|
3381
|
+
</dd>
|
|
3382
|
+
</dl>
|
|
3383
|
+
|
|
3384
|
+
#### ⚙️ Parameters
|
|
3385
|
+
|
|
3386
|
+
<dl>
|
|
3387
|
+
<dd>
|
|
3388
|
+
|
|
3389
|
+
<dl>
|
|
3390
|
+
<dd>
|
|
3391
|
+
|
|
3392
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
3393
|
+
|
|
3394
|
+
</dd>
|
|
3395
|
+
</dl>
|
|
3396
|
+
|
|
3397
|
+
<dl>
|
|
3398
|
+
<dd>
|
|
3399
|
+
|
|
3400
|
+
**request:** `AgentMail.BatchGetMessagesRequest`
|
|
3401
|
+
|
|
3402
|
+
</dd>
|
|
3403
|
+
</dl>
|
|
3404
|
+
|
|
3405
|
+
<dl>
|
|
3406
|
+
<dd>
|
|
3407
|
+
|
|
3408
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
3409
|
+
|
|
3410
|
+
</dd>
|
|
3411
|
+
</dl>
|
|
3412
|
+
</dd>
|
|
3413
|
+
</dl>
|
|
3414
|
+
|
|
3415
|
+
|
|
3333
3416
|
</dd>
|
|
3334
3417
|
</dl>
|
|
3335
3418
|
</details>
|