agentmail 0.4.18 → 0.4.19
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/domains/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/domains/client/Client.js +1 -1
- package/dist/cjs/api/resources/drafts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/drafts/client/Client.js +1 -1
- package/dist/cjs/api/resources/inboxEvents/exports.d.ts +1 -0
- package/dist/cjs/api/resources/inboxEvents/exports.js +18 -0
- package/dist/cjs/api/resources/inboxEvents/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxEvents/index.js +17 -0
- package/dist/cjs/api/resources/inboxEvents/types/InboxEvent.d.ts +17 -0
- package/dist/cjs/api/resources/inboxEvents/types/InboxEvent.js +3 -0
- package/dist/cjs/api/resources/inboxEvents/types/InboxEventId.d.ts +4 -0
- package/dist/cjs/api/resources/inboxEvents/types/InboxEventId.js +3 -0
- package/dist/cjs/api/resources/inboxEvents/types/InboxEventType.d.ts +6 -0
- package/dist/cjs/api/resources/inboxEvents/types/InboxEventType.js +9 -0
- package/dist/cjs/api/resources/inboxEvents/types/ListInboxEventsResponse.d.ts +8 -0
- package/dist/cjs/api/resources/inboxEvents/types/ListInboxEventsResponse.js +3 -0
- package/dist/cjs/api/resources/inboxEvents/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/inboxEvents/types/index.js +20 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +4 -1
- package/dist/cjs/api/resources/inboxes/client/Client.js +14 -9
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +1 -1
- package/dist/cjs/api/resources/inboxes/resources/events/client/Client.d.ts +32 -0
- package/dist/cjs/api/resources/inboxes/resources/events/client/Client.js +136 -0
- package/dist/cjs/api/resources/inboxes/resources/events/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/events/client/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.d.ts +10 -0
- package/dist/cjs/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/events/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/events/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/inboxes/resources/events/exports.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/events/exports.js +21 -0
- package/dist/cjs/api/resources/inboxes/resources/events/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/events/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/resources/index.js +3 -1
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js +1 -1
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +1 -1
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +1 -1
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +3 -1
- package/dist/cjs/api/resources/lists/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/lists/client/Client.js +1 -1
- package/dist/cjs/api/resources/organizations/client/Client.d.ts +6 -1
- package/dist/cjs/api/resources/organizations/client/Client.js +6 -1
- package/dist/cjs/api/resources/pods/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/pods/client/Client.js +1 -1
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +1 -1
- package/dist/cjs/api/resources/pods/resources/drafts/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/pods/resources/drafts/client/Client.js +1 -1
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +1 -1
- package/dist/cjs/api/resources/pods/resources/lists/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/pods/resources/lists/client/Client.js +1 -1
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +1 -1
- package/dist/cjs/api/resources/threads/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/threads/client/Client.js +2 -2
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/webhooks/client/Client.js +1 -1
- package/dist/cjs/serialization/resources/inboxEvents/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/inboxEvents/index.js +17 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEvent.d.ts +21 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEvent.js +53 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventId.d.ts +7 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventId.js +39 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventType.d.ts +7 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventType.js +39 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/ListInboxEventsResponse.d.ts +16 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/ListInboxEventsResponse.js +48 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/index.d.ts +4 -0
- package/dist/cjs/serialization/resources/inboxEvents/types/index.js +20 -0
- package/dist/cjs/serialization/resources/index.d.ts +2 -0
- package/dist/cjs/serialization/resources/index.js +3 -1
- 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/domains/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/domains/client/Client.mjs +1 -1
- package/dist/esm/api/resources/drafts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/drafts/client/Client.mjs +1 -1
- package/dist/esm/api/resources/inboxEvents/exports.d.mts +1 -0
- package/dist/esm/api/resources/inboxEvents/exports.mjs +2 -0
- package/dist/esm/api/resources/inboxEvents/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxEvents/index.mjs +1 -0
- package/dist/esm/api/resources/inboxEvents/types/InboxEvent.d.mts +17 -0
- package/dist/esm/api/resources/inboxEvents/types/InboxEvent.mjs +2 -0
- package/dist/esm/api/resources/inboxEvents/types/InboxEventId.d.mts +4 -0
- package/dist/esm/api/resources/inboxEvents/types/InboxEventId.mjs +2 -0
- package/dist/esm/api/resources/inboxEvents/types/InboxEventType.d.mts +6 -0
- package/dist/esm/api/resources/inboxEvents/types/InboxEventType.mjs +6 -0
- package/dist/esm/api/resources/inboxEvents/types/ListInboxEventsResponse.d.mts +8 -0
- package/dist/esm/api/resources/inboxEvents/types/ListInboxEventsResponse.mjs +2 -0
- package/dist/esm/api/resources/inboxEvents/types/index.d.mts +4 -0
- package/dist/esm/api/resources/inboxEvents/types/index.mjs +4 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +4 -1
- package/dist/esm/api/resources/inboxes/client/Client.mjs +6 -1
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +1 -1
- package/dist/esm/api/resources/inboxes/resources/events/client/Client.d.mts +32 -0
- package/dist/esm/api/resources/inboxes/resources/events/client/Client.mjs +99 -0
- package/dist/esm/api/resources/inboxes/resources/events/client/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/events/client/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.d.mts +10 -0
- package/dist/esm/api/resources/inboxes/resources/events/client/requests/ListInboxEventsRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/events/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/events/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/events/exports.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/events/exports.mjs +3 -0
- package/dist/esm/api/resources/inboxes/resources/events/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/events/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/resources/index.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.mjs +1 -1
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +1 -1
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +1 -1
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/lists/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/lists/client/Client.mjs +1 -1
- package/dist/esm/api/resources/organizations/client/Client.d.mts +6 -1
- package/dist/esm/api/resources/organizations/client/Client.mjs +6 -1
- package/dist/esm/api/resources/pods/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/pods/client/Client.mjs +1 -1
- package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +1 -1
- package/dist/esm/api/resources/pods/resources/drafts/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/pods/resources/drafts/client/Client.mjs +1 -1
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +1 -1
- package/dist/esm/api/resources/pods/resources/lists/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/pods/resources/lists/client/Client.mjs +1 -1
- package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +1 -1
- package/dist/esm/api/resources/threads/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/threads/client/Client.mjs +2 -2
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/webhooks/client/Client.mjs +1 -1
- package/dist/esm/serialization/resources/inboxEvents/index.d.mts +1 -0
- package/dist/esm/serialization/resources/inboxEvents/index.mjs +1 -0
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEvent.d.mts +21 -0
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEvent.mjs +17 -0
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEventId.d.mts +7 -0
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEventId.mjs +3 -0
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEventType.d.mts +7 -0
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEventType.mjs +3 -0
- package/dist/esm/serialization/resources/inboxEvents/types/ListInboxEventsResponse.d.mts +16 -0
- package/dist/esm/serialization/resources/inboxEvents/types/ListInboxEventsResponse.mjs +12 -0
- package/dist/esm/serialization/resources/inboxEvents/types/index.d.mts +4 -0
- package/dist/esm/serialization/resources/inboxEvents/types/index.mjs +4 -0
- package/dist/esm/serialization/resources/index.d.mts +2 -0
- package/dist/esm/serialization/resources/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +912 -362
- package/dist/llms.txt +9 -1
- package/package.json +12 -1
- package/reference.md +100 -18
package/dist/llms.txt
CHANGED
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
- [Guide: Multi-Tenancy](https://docs.agentmail.to/multi-tenancy.mdx): How to use pods, scoped API keys, and webhook filtering to build multi-tenant email on AgentMail.
|
|
31
31
|
- [Using Custom Domains](https://docs.agentmail.to/custom-domains.mdx): A step-by-step guide to configuring your custom domain with AgentMail for enhanced branding and trust.
|
|
32
32
|
- [Managing Your Domains](https://docs.agentmail.to/managing-domains.mdx): Learn how to manage your custom domains effectively using AgentMail's API for enhanced deliverability and reputation management.
|
|
33
|
-
- [Webhooks Overview](https://docs.agentmail.to/overview.mdx): Learn how to use Webhooks to build responsive, event-driven email agents with AgentMail.
|
|
33
|
+
- [Webhooks Overview](https://docs.agentmail.to/webhooks-overview.mdx): Learn how to use Webhooks to build responsive, event-driven email agents with AgentMail.
|
|
34
34
|
- [Webhook Events](https://docs.agentmail.to/events.mdx)
|
|
35
35
|
- [Webhook Setup Guide](https://docs.agentmail.to/webhook-setup.mdx): A comprehensive guide to setting up webhooks with ngrok and AgentMail, including account creation, inbox setup, and code examples.
|
|
36
36
|
- [Verifying Webhooks](https://docs.agentmail.to/webhook-verification.mdx): Learn how to verify webhook signatures to secure your webhook endpoints and prevent spoofed requests.
|
|
@@ -72,6 +72,7 @@
|
|
|
72
72
|
- [How do I prevent duplicate sends?](https://docs.agentmail.to/knowledge-base/preventing-duplicate-sends.mdx): Use idempotency to avoid sending the same email twice.
|
|
73
73
|
- [Why is my domain not verifying?](https://docs.agentmail.to/knowledge-base/domain-not-verifying.mdx): What to do when your domain verification is stuck.
|
|
74
74
|
- [Why are my emails bouncing?](https://docs.agentmail.to/knowledge-base/emails-bouncing.mdx): Diagnose and resolve email bounce issues.
|
|
75
|
+
- [Why are my emails not showing up?](https://docs.agentmail.to/knowledge-base/inbound-emails-missing.mdx): The most common reason inbound emails go missing is that the sender's domain isn't authenticated.
|
|
75
76
|
- [DNS Guide: Cloudflare](https://docs.agentmail.to/knowledge-base/dns-cloudflare.mdx): Step-by-step instructions for adding AgentMail DNS records in Cloudflare.
|
|
76
77
|
- [DNS Guide: GoDaddy](https://docs.agentmail.to/knowledge-base/dns-godaddy.mdx): Step-by-step instructions for adding AgentMail DNS records in GoDaddy.
|
|
77
78
|
- [DNS Guide: Route 53 (AWS)](https://docs.agentmail.to/knowledge-base/dns-route53.mdx): Step-by-step instructions for adding AgentMail DNS records in AWS Route 53.
|
|
@@ -191,3 +192,10 @@
|
|
|
191
192
|
The raw OpenAPI 3.1 specification for this API is available at:
|
|
192
193
|
- [OpenAPI JSON](https://docs.agentmail.to/openapi.json)
|
|
193
194
|
- [OpenAPI YAML](https://docs.agentmail.to/openapi.yaml)
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
## AsyncAPI Specification
|
|
198
|
+
|
|
199
|
+
The raw AsyncAPI 2.6.0 specification for the WebSocket channels is available at:
|
|
200
|
+
- [AsyncAPI JSON](https://docs.agentmail.to/asyncapi.json)
|
|
201
|
+
- [AsyncAPI YAML](https://docs.agentmail.to/asyncapi.yaml)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agentmail",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.19",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -132,6 +132,17 @@
|
|
|
132
132
|
},
|
|
133
133
|
"default": "./dist/cjs/api/resources/inboxes/resources/drafts/exports.js"
|
|
134
134
|
},
|
|
135
|
+
"./inboxes/events": {
|
|
136
|
+
"import": {
|
|
137
|
+
"types": "./dist/esm/api/resources/inboxes/resources/events/exports.d.mts",
|
|
138
|
+
"default": "./dist/esm/api/resources/inboxes/resources/events/exports.mjs"
|
|
139
|
+
},
|
|
140
|
+
"require": {
|
|
141
|
+
"types": "./dist/cjs/api/resources/inboxes/resources/events/exports.d.ts",
|
|
142
|
+
"default": "./dist/cjs/api/resources/inboxes/resources/events/exports.js"
|
|
143
|
+
},
|
|
144
|
+
"default": "./dist/cjs/api/resources/inboxes/resources/events/exports.js"
|
|
145
|
+
},
|
|
135
146
|
"./inboxes/lists": {
|
|
136
147
|
"import": {
|
|
137
148
|
"types": "./dist/esm/api/resources/inboxes/resources/lists/exports.d.mts",
|
package/reference.md
CHANGED
|
@@ -80,7 +80,7 @@ await client.inboxes.list();
|
|
|
80
80
|
|
|
81
81
|
**CLI:**
|
|
82
82
|
```bash
|
|
83
|
-
agentmail inboxes
|
|
83
|
+
agentmail inboxes get --inbox-id <inbox_id>
|
|
84
84
|
```
|
|
85
85
|
</dd>
|
|
86
86
|
</dl>
|
|
@@ -421,7 +421,7 @@ await client.pods.list();
|
|
|
421
421
|
|
|
422
422
|
**CLI:**
|
|
423
423
|
```bash
|
|
424
|
-
agentmail pods
|
|
424
|
+
agentmail pods get --pod-id <pod_id>
|
|
425
425
|
```
|
|
426
426
|
</dd>
|
|
427
427
|
</dl>
|
|
@@ -686,7 +686,7 @@ await client.webhooks.list();
|
|
|
686
686
|
|
|
687
687
|
**CLI:**
|
|
688
688
|
```bash
|
|
689
|
-
agentmail webhooks
|
|
689
|
+
agentmail webhooks get --webhook-id <webhook_id>
|
|
690
690
|
```
|
|
691
691
|
</dd>
|
|
692
692
|
</dl>
|
|
@@ -1379,7 +1379,7 @@ await client.domains.list();
|
|
|
1379
1379
|
|
|
1380
1380
|
**CLI:**
|
|
1381
1381
|
```bash
|
|
1382
|
-
agentmail domains
|
|
1382
|
+
agentmail domains get --domain-id <domain_id>
|
|
1383
1383
|
```
|
|
1384
1384
|
</dd>
|
|
1385
1385
|
</dl>
|
|
@@ -1853,7 +1853,7 @@ await client.drafts.list();
|
|
|
1853
1853
|
|
|
1854
1854
|
**CLI:**
|
|
1855
1855
|
```bash
|
|
1856
|
-
agentmail drafts
|
|
1856
|
+
agentmail drafts get --draft-id <draft_id>
|
|
1857
1857
|
```
|
|
1858
1858
|
</dd>
|
|
1859
1859
|
</dl>
|
|
@@ -2291,7 +2291,7 @@ await client.inboxes.drafts.list("inbox_id");
|
|
|
2291
2291
|
|
|
2292
2292
|
**CLI:**
|
|
2293
2293
|
```bash
|
|
2294
|
-
agentmail inboxes:drafts
|
|
2294
|
+
agentmail inboxes:drafts get --inbox-id <inbox_id> --draft-id <draft_id>
|
|
2295
2295
|
```
|
|
2296
2296
|
</dd>
|
|
2297
2297
|
</dl>
|
|
@@ -2741,6 +2741,83 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
|
2741
2741
|
</dl>
|
|
2742
2742
|
|
|
2743
2743
|
|
|
2744
|
+
</dd>
|
|
2745
|
+
</dl>
|
|
2746
|
+
</details>
|
|
2747
|
+
|
|
2748
|
+
## Inboxes Events
|
|
2749
|
+
<details><summary><code>client.inboxes.events.<a href="/src/api/resources/inboxes/resources/events/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListInboxEventsResponse</code></summary>
|
|
2750
|
+
<dl>
|
|
2751
|
+
<dd>
|
|
2752
|
+
|
|
2753
|
+
#### 📝 Description
|
|
2754
|
+
|
|
2755
|
+
<dl>
|
|
2756
|
+
<dd>
|
|
2757
|
+
|
|
2758
|
+
<dl>
|
|
2759
|
+
<dd>
|
|
2760
|
+
|
|
2761
|
+
List label change events for an inbox. Returns events in reverse chronological order by default. Use for IMAP UID projection or audit logging.
|
|
2762
|
+
|
|
2763
|
+
**CLI:**
|
|
2764
|
+
```bash
|
|
2765
|
+
agentmail inboxes:events list --inbox-id <inbox_id>
|
|
2766
|
+
```
|
|
2767
|
+
</dd>
|
|
2768
|
+
</dl>
|
|
2769
|
+
</dd>
|
|
2770
|
+
</dl>
|
|
2771
|
+
|
|
2772
|
+
#### 🔌 Usage
|
|
2773
|
+
|
|
2774
|
+
<dl>
|
|
2775
|
+
<dd>
|
|
2776
|
+
|
|
2777
|
+
<dl>
|
|
2778
|
+
<dd>
|
|
2779
|
+
|
|
2780
|
+
```typescript
|
|
2781
|
+
await client.inboxes.events.list("inbox_id");
|
|
2782
|
+
|
|
2783
|
+
```
|
|
2784
|
+
</dd>
|
|
2785
|
+
</dl>
|
|
2786
|
+
</dd>
|
|
2787
|
+
</dl>
|
|
2788
|
+
|
|
2789
|
+
#### ⚙️ Parameters
|
|
2790
|
+
|
|
2791
|
+
<dl>
|
|
2792
|
+
<dd>
|
|
2793
|
+
|
|
2794
|
+
<dl>
|
|
2795
|
+
<dd>
|
|
2796
|
+
|
|
2797
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2798
|
+
|
|
2799
|
+
</dd>
|
|
2800
|
+
</dl>
|
|
2801
|
+
|
|
2802
|
+
<dl>
|
|
2803
|
+
<dd>
|
|
2804
|
+
|
|
2805
|
+
**request:** `AgentMail.inboxes.ListInboxEventsRequest`
|
|
2806
|
+
|
|
2807
|
+
</dd>
|
|
2808
|
+
</dl>
|
|
2809
|
+
|
|
2810
|
+
<dl>
|
|
2811
|
+
<dd>
|
|
2812
|
+
|
|
2813
|
+
**requestOptions:** `EventsClient.RequestOptions`
|
|
2814
|
+
|
|
2815
|
+
</dd>
|
|
2816
|
+
</dl>
|
|
2817
|
+
</dd>
|
|
2818
|
+
</dl>
|
|
2819
|
+
|
|
2820
|
+
|
|
2744
2821
|
</dd>
|
|
2745
2822
|
</dl>
|
|
2746
2823
|
</details>
|
|
@@ -2850,7 +2927,7 @@ await client.inboxes.lists.list("inbox_id", "send", "allow");
|
|
|
2850
2927
|
|
|
2851
2928
|
**CLI:**
|
|
2852
2929
|
```bash
|
|
2853
|
-
agentmail inboxes:lists
|
|
2930
|
+
agentmail inboxes:lists get --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
|
|
2854
2931
|
```
|
|
2855
2932
|
</dd>
|
|
2856
2933
|
</dl>
|
|
@@ -3197,7 +3274,7 @@ await client.inboxes.messages.list("inbox_id");
|
|
|
3197
3274
|
|
|
3198
3275
|
**CLI:**
|
|
3199
3276
|
```bash
|
|
3200
|
-
agentmail inboxes:messages
|
|
3277
|
+
agentmail inboxes:messages get --inbox-id <inbox_id> --message-id <message_id>
|
|
3201
3278
|
```
|
|
3202
3279
|
</dd>
|
|
3203
3280
|
</dl>
|
|
@@ -4055,7 +4132,7 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4055
4132
|
|
|
4056
4133
|
**CLI:**
|
|
4057
4134
|
```bash
|
|
4058
|
-
agentmail inboxes:threads
|
|
4135
|
+
agentmail inboxes:threads get --inbox-id <inbox_id> --thread-id <thread_id>
|
|
4059
4136
|
```
|
|
4060
4137
|
</dd>
|
|
4061
4138
|
</dl>
|
|
@@ -4457,7 +4534,7 @@ await client.lists.list("send", "allow");
|
|
|
4457
4534
|
|
|
4458
4535
|
**CLI:**
|
|
4459
4536
|
```bash
|
|
4460
|
-
agentmail lists
|
|
4537
|
+
agentmail lists get --direction <direction> --type <type> --entry <entry>
|
|
4461
4538
|
```
|
|
4462
4539
|
</dd>
|
|
4463
4540
|
</dl>
|
|
@@ -4771,7 +4848,12 @@ await client.metrics.query();
|
|
|
4771
4848
|
<dl>
|
|
4772
4849
|
<dd>
|
|
4773
4850
|
|
|
4774
|
-
|
|
4851
|
+
Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).
|
|
4852
|
+
|
|
4853
|
+
**CLI:**
|
|
4854
|
+
```bash
|
|
4855
|
+
agentmail organizations get
|
|
4856
|
+
```
|
|
4775
4857
|
</dd>
|
|
4776
4858
|
</dl>
|
|
4777
4859
|
</dd>
|
|
@@ -5126,7 +5208,7 @@ await client.pods.domains.list("pod_id");
|
|
|
5126
5208
|
|
|
5127
5209
|
**CLI:**
|
|
5128
5210
|
```bash
|
|
5129
|
-
agentmail pods:domains
|
|
5211
|
+
agentmail pods:domains get --pod-id <pod_id> --domain-id <domain_id>
|
|
5130
5212
|
```
|
|
5131
5213
|
</dd>
|
|
5132
5214
|
</dl>
|
|
@@ -5656,7 +5738,7 @@ await client.pods.drafts.list("pod_id");
|
|
|
5656
5738
|
|
|
5657
5739
|
**CLI:**
|
|
5658
5740
|
```bash
|
|
5659
|
-
agentmail pods:drafts
|
|
5741
|
+
agentmail pods:drafts get --pod-id <pod_id> --draft-id <draft_id>
|
|
5660
5742
|
```
|
|
5661
5743
|
</dd>
|
|
5662
5744
|
</dl>
|
|
@@ -5887,7 +5969,7 @@ await client.pods.inboxes.list("pod_id");
|
|
|
5887
5969
|
|
|
5888
5970
|
**CLI:**
|
|
5889
5971
|
```bash
|
|
5890
|
-
agentmail pods:inboxes
|
|
5972
|
+
agentmail pods:inboxes get --pod-id <pod_id> --inbox-id <inbox_id>
|
|
5891
5973
|
```
|
|
5892
5974
|
</dd>
|
|
5893
5975
|
</dl>
|
|
@@ -6284,7 +6366,7 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
6284
6366
|
|
|
6285
6367
|
**CLI:**
|
|
6286
6368
|
```bash
|
|
6287
|
-
agentmail pods:lists
|
|
6369
|
+
agentmail pods:lists get --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
6288
6370
|
```
|
|
6289
6371
|
</dd>
|
|
6290
6372
|
</dl>
|
|
@@ -6706,7 +6788,7 @@ await client.pods.threads.list("pod_id");
|
|
|
6706
6788
|
|
|
6707
6789
|
**CLI:**
|
|
6708
6790
|
```bash
|
|
6709
|
-
agentmail pods:threads
|
|
6791
|
+
agentmail pods:threads get --pod-id <pod_id> --thread-id <thread_id>
|
|
6710
6792
|
```
|
|
6711
6793
|
</dd>
|
|
6712
6794
|
</dl>
|
|
@@ -7092,7 +7174,7 @@ await client.threads.list();
|
|
|
7092
7174
|
|
|
7093
7175
|
**CLI:**
|
|
7094
7176
|
```bash
|
|
7095
|
-
agentmail threads
|
|
7177
|
+
agentmail threads get --thread-id <thread_id>
|
|
7096
7178
|
```
|
|
7097
7179
|
</dd>
|
|
7098
7180
|
</dl>
|
|
@@ -7158,7 +7240,7 @@ await client.threads.get("thread_id");
|
|
|
7158
7240
|
|
|
7159
7241
|
**CLI:**
|
|
7160
7242
|
```bash
|
|
7161
|
-
agentmail threads
|
|
7243
|
+
agentmail threads get-attachment --thread-id <thread_id> --attachment-id <attachment_id>
|
|
7162
7244
|
```
|
|
7163
7245
|
</dd>
|
|
7164
7246
|
</dl>
|