agentmail 0.4.15 → 0.4.16
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 +13 -1
- package/dist/cjs/api/resources/agent/client/Client.js +13 -1
- package/dist/cjs/api/resources/apiKeys/client/Client.d.ts +16 -3
- package/dist/cjs/api/resources/apiKeys/client/Client.js +16 -3
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
- package/dist/cjs/api/resources/domains/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/domains/client/Client.js +35 -0
- package/dist/cjs/api/resources/domains/types/DomainItem.d.ts +0 -1
- package/dist/cjs/api/resources/drafts/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/drafts/client/Client.js +15 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/inboxes/client/Client.js +25 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.d.ts +16 -3
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.js +16 -3
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/inboxes/resources/drafts/client/Client.js +35 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js +20 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.d.ts +45 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +45 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.d.ts +5 -0
- package/dist/cjs/api/resources/inboxes/resources/metrics/client/Client.js +5 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +20 -0
- package/dist/cjs/api/resources/lists/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/lists/client/Client.js +20 -0
- package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.d.ts +4 -0
- package/dist/cjs/api/resources/messages/types/UpdateMessageLabels.js +3 -0
- package/dist/cjs/api/resources/messages/types/UpdateMessageRequest.d.ts +5 -4
- package/dist/cjs/api/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/index.js +1 -0
- package/dist/cjs/api/resources/metrics/client/Client.d.ts +5 -0
- package/dist/cjs/api/resources/metrics/client/Client.js +5 -0
- package/dist/cjs/api/resources/pods/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/pods/client/Client.js +20 -0
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.d.ts +16 -3
- package/dist/cjs/api/resources/pods/resources/apiKeys/client/Client.js +16 -3
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/pods/resources/domains/client/Client.js +35 -0
- package/dist/cjs/api/resources/pods/resources/drafts/client/Client.d.ts +15 -0
- package/dist/cjs/api/resources/pods/resources/drafts/client/Client.js +15 -0
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/pods/resources/inboxes/client/Client.js +25 -0
- package/dist/cjs/api/resources/pods/resources/lists/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/pods/resources/lists/client/Client.js +20 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.d.ts +5 -0
- package/dist/cjs/api/resources/pods/resources/metrics/client/Client.js +5 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +20 -0
- package/dist/cjs/api/resources/threads/client/Client.d.ts +20 -0
- package/dist/cjs/api/resources/threads/client/Client.js +20 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/webhooks/client/Client.js +25 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.ts +1 -1
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyRequest.js +1 -1
- package/dist/cjs/serialization/resources/domains/types/DomainItem.d.ts +0 -2
- package/dist/cjs/serialization/resources/domains/types/DomainItem.js +0 -2
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.d.ts +7 -0
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageLabels.js +42 -0
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.d.ts +3 -2
- package/dist/cjs/serialization/resources/messages/types/UpdateMessageRequest.js +3 -2
- package/dist/cjs/serialization/resources/messages/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/messages/types/index.js +1 -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 +13 -1
- package/dist/esm/api/resources/agent/client/Client.mjs +13 -1
- package/dist/esm/api/resources/apiKeys/client/Client.d.mts +16 -3
- package/dist/esm/api/resources/apiKeys/client/Client.mjs +16 -3
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
- package/dist/esm/api/resources/domains/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/domains/client/Client.mjs +35 -0
- package/dist/esm/api/resources/domains/types/DomainItem.d.mts +0 -1
- package/dist/esm/api/resources/drafts/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/drafts/client/Client.mjs +15 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/inboxes/client/Client.mjs +25 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.d.mts +16 -3
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.mjs +16 -3
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/inboxes/resources/drafts/client/Client.mjs +35 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.mjs +20 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.d.mts +45 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +45 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.d.mts +5 -0
- package/dist/esm/api/resources/inboxes/resources/metrics/client/Client.mjs +5 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +20 -0
- package/dist/esm/api/resources/lists/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/lists/client/Client.mjs +20 -0
- package/dist/esm/api/resources/messages/types/UpdateMessageLabels.d.mts +4 -0
- package/dist/esm/api/resources/messages/types/UpdateMessageLabels.mjs +2 -0
- package/dist/esm/api/resources/messages/types/UpdateMessageRequest.d.mts +5 -4
- package/dist/esm/api/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/index.mjs +1 -0
- package/dist/esm/api/resources/metrics/client/Client.d.mts +5 -0
- package/dist/esm/api/resources/metrics/client/Client.mjs +5 -0
- package/dist/esm/api/resources/pods/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/pods/client/Client.mjs +20 -0
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.d.mts +16 -3
- package/dist/esm/api/resources/pods/resources/apiKeys/client/Client.mjs +16 -3
- package/dist/esm/api/resources/pods/resources/domains/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/pods/resources/domains/client/Client.mjs +35 -0
- package/dist/esm/api/resources/pods/resources/drafts/client/Client.d.mts +15 -0
- package/dist/esm/api/resources/pods/resources/drafts/client/Client.mjs +15 -0
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/pods/resources/inboxes/client/Client.mjs +25 -0
- package/dist/esm/api/resources/pods/resources/lists/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/pods/resources/lists/client/Client.mjs +20 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.d.mts +5 -0
- package/dist/esm/api/resources/pods/resources/metrics/client/Client.mjs +5 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +20 -0
- package/dist/esm/api/resources/threads/client/Client.d.mts +20 -0
- package/dist/esm/api/resources/threads/client/Client.mjs +20 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/webhooks/client/Client.mjs +25 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.d.mts +1 -1
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyRequest.mjs +1 -1
- package/dist/esm/serialization/resources/domains/types/DomainItem.d.mts +0 -2
- package/dist/esm/serialization/resources/domains/types/DomainItem.mjs +0 -2
- package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.d.mts +7 -0
- package/dist/esm/serialization/resources/messages/types/UpdateMessageLabels.mjs +6 -0
- package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.d.mts +3 -2
- package/dist/esm/serialization/resources/messages/types/UpdateMessageRequest.mjs +3 -2
- package/dist/esm/serialization/resources/messages/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/messages/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +2836 -568
- package/dist/llms.txt +3 -0
- package/package.json +1 -1
- package/reference.md +1532 -15
package/reference.md
CHANGED
|
@@ -4,6 +4,23 @@
|
|
|
4
4
|
<dl>
|
|
5
5
|
<dd>
|
|
6
6
|
|
|
7
|
+
#### 📝 Description
|
|
8
|
+
|
|
9
|
+
<dl>
|
|
10
|
+
<dd>
|
|
11
|
+
|
|
12
|
+
<dl>
|
|
13
|
+
<dd>
|
|
14
|
+
|
|
15
|
+
**CLI:**
|
|
16
|
+
```bash
|
|
17
|
+
agentmail inboxes list
|
|
18
|
+
```
|
|
19
|
+
</dd>
|
|
20
|
+
</dl>
|
|
21
|
+
</dd>
|
|
22
|
+
</dl>
|
|
23
|
+
|
|
7
24
|
#### 🔌 Usage
|
|
8
25
|
|
|
9
26
|
<dl>
|
|
@@ -53,6 +70,23 @@ await client.inboxes.list();
|
|
|
53
70
|
<dl>
|
|
54
71
|
<dd>
|
|
55
72
|
|
|
73
|
+
#### 📝 Description
|
|
74
|
+
|
|
75
|
+
<dl>
|
|
76
|
+
<dd>
|
|
77
|
+
|
|
78
|
+
<dl>
|
|
79
|
+
<dd>
|
|
80
|
+
|
|
81
|
+
**CLI:**
|
|
82
|
+
```bash
|
|
83
|
+
agentmail inboxes retrieve --inbox-id <inbox_id>
|
|
84
|
+
```
|
|
85
|
+
</dd>
|
|
86
|
+
</dl>
|
|
87
|
+
</dd>
|
|
88
|
+
</dl>
|
|
89
|
+
|
|
56
90
|
#### 🔌 Usage
|
|
57
91
|
|
|
58
92
|
<dl>
|
|
@@ -102,6 +136,23 @@ await client.inboxes.get("inbox_id");
|
|
|
102
136
|
<dl>
|
|
103
137
|
<dd>
|
|
104
138
|
|
|
139
|
+
#### 📝 Description
|
|
140
|
+
|
|
141
|
+
<dl>
|
|
142
|
+
<dd>
|
|
143
|
+
|
|
144
|
+
<dl>
|
|
145
|
+
<dd>
|
|
146
|
+
|
|
147
|
+
**CLI:**
|
|
148
|
+
```bash
|
|
149
|
+
agentmail inboxes create --display-name "My Agent" --username myagent --domain agentmail.to
|
|
150
|
+
```
|
|
151
|
+
</dd>
|
|
152
|
+
</dl>
|
|
153
|
+
</dd>
|
|
154
|
+
</dl>
|
|
155
|
+
|
|
105
156
|
#### 🔌 Usage
|
|
106
157
|
|
|
107
158
|
<dl>
|
|
@@ -151,6 +202,23 @@ await client.inboxes.create(undefined);
|
|
|
151
202
|
<dl>
|
|
152
203
|
<dd>
|
|
153
204
|
|
|
205
|
+
#### 📝 Description
|
|
206
|
+
|
|
207
|
+
<dl>
|
|
208
|
+
<dd>
|
|
209
|
+
|
|
210
|
+
<dl>
|
|
211
|
+
<dd>
|
|
212
|
+
|
|
213
|
+
**CLI:**
|
|
214
|
+
```bash
|
|
215
|
+
agentmail inboxes update --inbox-id <inbox_id> --display-name "Updated Name"
|
|
216
|
+
```
|
|
217
|
+
</dd>
|
|
218
|
+
</dl>
|
|
219
|
+
</dd>
|
|
220
|
+
</dl>
|
|
221
|
+
|
|
154
222
|
#### 🔌 Usage
|
|
155
223
|
|
|
156
224
|
<dl>
|
|
@@ -210,6 +278,23 @@ await client.inboxes.update("inbox_id", {
|
|
|
210
278
|
<dl>
|
|
211
279
|
<dd>
|
|
212
280
|
|
|
281
|
+
#### 📝 Description
|
|
282
|
+
|
|
283
|
+
<dl>
|
|
284
|
+
<dd>
|
|
285
|
+
|
|
286
|
+
<dl>
|
|
287
|
+
<dd>
|
|
288
|
+
|
|
289
|
+
**CLI:**
|
|
290
|
+
```bash
|
|
291
|
+
agentmail inboxes delete --inbox-id <inbox_id>
|
|
292
|
+
```
|
|
293
|
+
</dd>
|
|
294
|
+
</dl>
|
|
295
|
+
</dd>
|
|
296
|
+
</dl>
|
|
297
|
+
|
|
213
298
|
#### 🔌 Usage
|
|
214
299
|
|
|
215
300
|
<dl>
|
|
@@ -260,6 +345,23 @@ await client.inboxes.delete("inbox_id");
|
|
|
260
345
|
<dl>
|
|
261
346
|
<dd>
|
|
262
347
|
|
|
348
|
+
#### 📝 Description
|
|
349
|
+
|
|
350
|
+
<dl>
|
|
351
|
+
<dd>
|
|
352
|
+
|
|
353
|
+
<dl>
|
|
354
|
+
<dd>
|
|
355
|
+
|
|
356
|
+
**CLI:**
|
|
357
|
+
```bash
|
|
358
|
+
agentmail pods list
|
|
359
|
+
```
|
|
360
|
+
</dd>
|
|
361
|
+
</dl>
|
|
362
|
+
</dd>
|
|
363
|
+
</dl>
|
|
364
|
+
|
|
263
365
|
#### 🔌 Usage
|
|
264
366
|
|
|
265
367
|
<dl>
|
|
@@ -309,6 +411,23 @@ await client.pods.list();
|
|
|
309
411
|
<dl>
|
|
310
412
|
<dd>
|
|
311
413
|
|
|
414
|
+
#### 📝 Description
|
|
415
|
+
|
|
416
|
+
<dl>
|
|
417
|
+
<dd>
|
|
418
|
+
|
|
419
|
+
<dl>
|
|
420
|
+
<dd>
|
|
421
|
+
|
|
422
|
+
**CLI:**
|
|
423
|
+
```bash
|
|
424
|
+
agentmail pods retrieve --pod-id <pod_id>
|
|
425
|
+
```
|
|
426
|
+
</dd>
|
|
427
|
+
</dl>
|
|
428
|
+
</dd>
|
|
429
|
+
</dl>
|
|
430
|
+
|
|
312
431
|
#### 🔌 Usage
|
|
313
432
|
|
|
314
433
|
<dl>
|
|
@@ -358,6 +477,23 @@ await client.pods.get("pod_id");
|
|
|
358
477
|
<dl>
|
|
359
478
|
<dd>
|
|
360
479
|
|
|
480
|
+
#### 📝 Description
|
|
481
|
+
|
|
482
|
+
<dl>
|
|
483
|
+
<dd>
|
|
484
|
+
|
|
485
|
+
<dl>
|
|
486
|
+
<dd>
|
|
487
|
+
|
|
488
|
+
**CLI:**
|
|
489
|
+
```bash
|
|
490
|
+
agentmail pods create --client-id my-pod
|
|
491
|
+
```
|
|
492
|
+
</dd>
|
|
493
|
+
</dl>
|
|
494
|
+
</dd>
|
|
495
|
+
</dl>
|
|
496
|
+
|
|
361
497
|
#### 🔌 Usage
|
|
362
498
|
|
|
363
499
|
<dl>
|
|
@@ -407,6 +543,23 @@ await client.pods.create({});
|
|
|
407
543
|
<dl>
|
|
408
544
|
<dd>
|
|
409
545
|
|
|
546
|
+
#### 📝 Description
|
|
547
|
+
|
|
548
|
+
<dl>
|
|
549
|
+
<dd>
|
|
550
|
+
|
|
551
|
+
<dl>
|
|
552
|
+
<dd>
|
|
553
|
+
|
|
554
|
+
**CLI:**
|
|
555
|
+
```bash
|
|
556
|
+
agentmail pods delete --pod-id <pod_id>
|
|
557
|
+
```
|
|
558
|
+
</dd>
|
|
559
|
+
</dl>
|
|
560
|
+
</dd>
|
|
561
|
+
</dl>
|
|
562
|
+
|
|
410
563
|
#### 🔌 Usage
|
|
411
564
|
|
|
412
565
|
<dl>
|
|
@@ -457,6 +610,23 @@ await client.pods.delete("pod_id");
|
|
|
457
610
|
<dl>
|
|
458
611
|
<dd>
|
|
459
612
|
|
|
613
|
+
#### 📝 Description
|
|
614
|
+
|
|
615
|
+
<dl>
|
|
616
|
+
<dd>
|
|
617
|
+
|
|
618
|
+
<dl>
|
|
619
|
+
<dd>
|
|
620
|
+
|
|
621
|
+
**CLI:**
|
|
622
|
+
```bash
|
|
623
|
+
agentmail webhooks list
|
|
624
|
+
```
|
|
625
|
+
</dd>
|
|
626
|
+
</dl>
|
|
627
|
+
</dd>
|
|
628
|
+
</dl>
|
|
629
|
+
|
|
460
630
|
#### 🔌 Usage
|
|
461
631
|
|
|
462
632
|
<dl>
|
|
@@ -506,6 +676,23 @@ await client.webhooks.list();
|
|
|
506
676
|
<dl>
|
|
507
677
|
<dd>
|
|
508
678
|
|
|
679
|
+
#### 📝 Description
|
|
680
|
+
|
|
681
|
+
<dl>
|
|
682
|
+
<dd>
|
|
683
|
+
|
|
684
|
+
<dl>
|
|
685
|
+
<dd>
|
|
686
|
+
|
|
687
|
+
**CLI:**
|
|
688
|
+
```bash
|
|
689
|
+
agentmail webhooks retrieve --webhook-id <webhook_id>
|
|
690
|
+
```
|
|
691
|
+
</dd>
|
|
692
|
+
</dl>
|
|
693
|
+
</dd>
|
|
694
|
+
</dl>
|
|
695
|
+
|
|
509
696
|
#### 🔌 Usage
|
|
510
697
|
|
|
511
698
|
<dl>
|
|
@@ -555,6 +742,23 @@ await client.webhooks.get("webhook_id");
|
|
|
555
742
|
<dl>
|
|
556
743
|
<dd>
|
|
557
744
|
|
|
745
|
+
#### 📝 Description
|
|
746
|
+
|
|
747
|
+
<dl>
|
|
748
|
+
<dd>
|
|
749
|
+
|
|
750
|
+
<dl>
|
|
751
|
+
<dd>
|
|
752
|
+
|
|
753
|
+
**CLI:**
|
|
754
|
+
```bash
|
|
755
|
+
agentmail webhooks create --url https://example.com/webhook --event-type message.received
|
|
756
|
+
```
|
|
757
|
+
</dd>
|
|
758
|
+
</dl>
|
|
759
|
+
</dd>
|
|
760
|
+
</dl>
|
|
761
|
+
|
|
558
762
|
#### 🔌 Usage
|
|
559
763
|
|
|
560
764
|
<dl>
|
|
@@ -607,6 +811,23 @@ await client.webhooks.create({
|
|
|
607
811
|
<dl>
|
|
608
812
|
<dd>
|
|
609
813
|
|
|
814
|
+
#### 📝 Description
|
|
815
|
+
|
|
816
|
+
<dl>
|
|
817
|
+
<dd>
|
|
818
|
+
|
|
819
|
+
<dl>
|
|
820
|
+
<dd>
|
|
821
|
+
|
|
822
|
+
**CLI:**
|
|
823
|
+
```bash
|
|
824
|
+
agentmail webhooks update --webhook-id <webhook_id> --add-inbox-id <inbox_id>
|
|
825
|
+
```
|
|
826
|
+
</dd>
|
|
827
|
+
</dl>
|
|
828
|
+
</dd>
|
|
829
|
+
</dl>
|
|
830
|
+
|
|
610
831
|
#### 🔌 Usage
|
|
611
832
|
|
|
612
833
|
<dl>
|
|
@@ -664,6 +885,23 @@ await client.webhooks.update("webhook_id", {});
|
|
|
664
885
|
<dl>
|
|
665
886
|
<dd>
|
|
666
887
|
|
|
888
|
+
#### 📝 Description
|
|
889
|
+
|
|
890
|
+
<dl>
|
|
891
|
+
<dd>
|
|
892
|
+
|
|
893
|
+
<dl>
|
|
894
|
+
<dd>
|
|
895
|
+
|
|
896
|
+
**CLI:**
|
|
897
|
+
```bash
|
|
898
|
+
agentmail webhooks delete --webhook-id <webhook_id>
|
|
899
|
+
```
|
|
900
|
+
</dd>
|
|
901
|
+
</dl>
|
|
902
|
+
</dd>
|
|
903
|
+
</dl>
|
|
904
|
+
|
|
667
905
|
#### 🔌 Usage
|
|
668
906
|
|
|
669
907
|
<dl>
|
|
@@ -722,11 +960,18 @@ await client.webhooks.delete("webhook_id");
|
|
|
722
960
|
<dl>
|
|
723
961
|
<dd>
|
|
724
962
|
|
|
725
|
-
Create a new agent organization with an inbox and API key.
|
|
963
|
+
Create a new agent organization with an inbox and API key. This endpoint is for signing up for the first time. If you've already signed up, you're all set — just use your existing API key.
|
|
964
|
+
|
|
965
|
+
A 6-digit OTP is sent to the human's email for verification.
|
|
726
966
|
|
|
727
967
|
This endpoint is idempotent. Calling it again with the same `human_email` will rotate the API key and resend the OTP if expired.
|
|
728
968
|
|
|
729
969
|
The returned API key has limited permissions until the organization is verified via the verify endpoint.
|
|
970
|
+
|
|
971
|
+
**CLI:**
|
|
972
|
+
```bash
|
|
973
|
+
agentmail agent sign-up --human-email user@example.com --username my-agent
|
|
974
|
+
```
|
|
730
975
|
</dd>
|
|
731
976
|
</dl>
|
|
732
977
|
</dd>
|
|
@@ -797,6 +1042,11 @@ Verify an agent organization using the 6-digit OTP sent to the human's email dur
|
|
|
797
1042
|
On success, the organization is upgraded from `agent_unverified` to `agent_verified`, the send allowlist is removed, and free plan entitlements are applied.
|
|
798
1043
|
|
|
799
1044
|
The OTP expires after 24 hours and allows a maximum of 10 attempts.
|
|
1045
|
+
|
|
1046
|
+
**CLI:**
|
|
1047
|
+
```bash
|
|
1048
|
+
agentmail agent verify --otp-code 123456
|
|
1049
|
+
```
|
|
800
1050
|
</dd>
|
|
801
1051
|
</dl>
|
|
802
1052
|
</dd>
|
|
@@ -854,6 +1104,23 @@ await client.agent.verify({
|
|
|
854
1104
|
<dl>
|
|
855
1105
|
<dd>
|
|
856
1106
|
|
|
1107
|
+
#### 📝 Description
|
|
1108
|
+
|
|
1109
|
+
<dl>
|
|
1110
|
+
<dd>
|
|
1111
|
+
|
|
1112
|
+
<dl>
|
|
1113
|
+
<dd>
|
|
1114
|
+
|
|
1115
|
+
**CLI:**
|
|
1116
|
+
```bash
|
|
1117
|
+
agentmail api-keys list
|
|
1118
|
+
```
|
|
1119
|
+
</dd>
|
|
1120
|
+
</dl>
|
|
1121
|
+
</dd>
|
|
1122
|
+
</dl>
|
|
1123
|
+
|
|
857
1124
|
#### 🔌 Usage
|
|
858
1125
|
|
|
859
1126
|
<dl>
|
|
@@ -903,6 +1170,23 @@ await client.apiKeys.list();
|
|
|
903
1170
|
<dl>
|
|
904
1171
|
<dd>
|
|
905
1172
|
|
|
1173
|
+
#### 📝 Description
|
|
1174
|
+
|
|
1175
|
+
<dl>
|
|
1176
|
+
<dd>
|
|
1177
|
+
|
|
1178
|
+
<dl>
|
|
1179
|
+
<dd>
|
|
1180
|
+
|
|
1181
|
+
**CLI:**
|
|
1182
|
+
```bash
|
|
1183
|
+
agentmail api-keys create --name "My Key"
|
|
1184
|
+
```
|
|
1185
|
+
</dd>
|
|
1186
|
+
</dl>
|
|
1187
|
+
</dd>
|
|
1188
|
+
</dl>
|
|
1189
|
+
|
|
906
1190
|
#### 🔌 Usage
|
|
907
1191
|
|
|
908
1192
|
<dl>
|
|
@@ -912,9 +1196,7 @@ await client.apiKeys.list();
|
|
|
912
1196
|
<dd>
|
|
913
1197
|
|
|
914
1198
|
```typescript
|
|
915
|
-
await client.apiKeys.create({
|
|
916
|
-
name: "name"
|
|
917
|
-
});
|
|
1199
|
+
await client.apiKeys.create({});
|
|
918
1200
|
|
|
919
1201
|
```
|
|
920
1202
|
</dd>
|
|
@@ -954,6 +1236,23 @@ await client.apiKeys.create({
|
|
|
954
1236
|
<dl>
|
|
955
1237
|
<dd>
|
|
956
1238
|
|
|
1239
|
+
#### 📝 Description
|
|
1240
|
+
|
|
1241
|
+
<dl>
|
|
1242
|
+
<dd>
|
|
1243
|
+
|
|
1244
|
+
<dl>
|
|
1245
|
+
<dd>
|
|
1246
|
+
|
|
1247
|
+
**CLI:**
|
|
1248
|
+
```bash
|
|
1249
|
+
agentmail api-keys delete --api-key-id <api_key_id>
|
|
1250
|
+
```
|
|
1251
|
+
</dd>
|
|
1252
|
+
</dl>
|
|
1253
|
+
</dd>
|
|
1254
|
+
</dl>
|
|
1255
|
+
|
|
957
1256
|
#### 🔌 Usage
|
|
958
1257
|
|
|
959
1258
|
<dl>
|
|
@@ -1004,6 +1303,23 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1004
1303
|
<dl>
|
|
1005
1304
|
<dd>
|
|
1006
1305
|
|
|
1306
|
+
#### 📝 Description
|
|
1307
|
+
|
|
1308
|
+
<dl>
|
|
1309
|
+
<dd>
|
|
1310
|
+
|
|
1311
|
+
<dl>
|
|
1312
|
+
<dd>
|
|
1313
|
+
|
|
1314
|
+
**CLI:**
|
|
1315
|
+
```bash
|
|
1316
|
+
agentmail domains list
|
|
1317
|
+
```
|
|
1318
|
+
</dd>
|
|
1319
|
+
</dl>
|
|
1320
|
+
</dd>
|
|
1321
|
+
</dl>
|
|
1322
|
+
|
|
1007
1323
|
#### 🔌 Usage
|
|
1008
1324
|
|
|
1009
1325
|
<dl>
|
|
@@ -1053,6 +1369,23 @@ await client.domains.list();
|
|
|
1053
1369
|
<dl>
|
|
1054
1370
|
<dd>
|
|
1055
1371
|
|
|
1372
|
+
#### 📝 Description
|
|
1373
|
+
|
|
1374
|
+
<dl>
|
|
1375
|
+
<dd>
|
|
1376
|
+
|
|
1377
|
+
<dl>
|
|
1378
|
+
<dd>
|
|
1379
|
+
|
|
1380
|
+
**CLI:**
|
|
1381
|
+
```bash
|
|
1382
|
+
agentmail domains retrieve --domain-id <domain_id>
|
|
1383
|
+
```
|
|
1384
|
+
</dd>
|
|
1385
|
+
</dl>
|
|
1386
|
+
</dd>
|
|
1387
|
+
</dl>
|
|
1388
|
+
|
|
1056
1389
|
#### 🔌 Usage
|
|
1057
1390
|
|
|
1058
1391
|
<dl>
|
|
@@ -1102,6 +1435,23 @@ await client.domains.get("domain_id");
|
|
|
1102
1435
|
<dl>
|
|
1103
1436
|
<dd>
|
|
1104
1437
|
|
|
1438
|
+
#### 📝 Description
|
|
1439
|
+
|
|
1440
|
+
<dl>
|
|
1441
|
+
<dd>
|
|
1442
|
+
|
|
1443
|
+
<dl>
|
|
1444
|
+
<dd>
|
|
1445
|
+
|
|
1446
|
+
**CLI:**
|
|
1447
|
+
```bash
|
|
1448
|
+
agentmail domains get-zone-file --domain-id <domain_id>
|
|
1449
|
+
```
|
|
1450
|
+
</dd>
|
|
1451
|
+
</dl>
|
|
1452
|
+
</dd>
|
|
1453
|
+
</dl>
|
|
1454
|
+
|
|
1105
1455
|
#### 🔌 Usage
|
|
1106
1456
|
|
|
1107
1457
|
<dl>
|
|
@@ -1151,6 +1501,23 @@ await client.domains.getZoneFile("domain_id");
|
|
|
1151
1501
|
<dl>
|
|
1152
1502
|
<dd>
|
|
1153
1503
|
|
|
1504
|
+
#### 📝 Description
|
|
1505
|
+
|
|
1506
|
+
<dl>
|
|
1507
|
+
<dd>
|
|
1508
|
+
|
|
1509
|
+
<dl>
|
|
1510
|
+
<dd>
|
|
1511
|
+
|
|
1512
|
+
**CLI:**
|
|
1513
|
+
```bash
|
|
1514
|
+
agentmail domains create --domain example.com
|
|
1515
|
+
```
|
|
1516
|
+
</dd>
|
|
1517
|
+
</dl>
|
|
1518
|
+
</dd>
|
|
1519
|
+
</dl>
|
|
1520
|
+
|
|
1154
1521
|
#### 🔌 Usage
|
|
1155
1522
|
|
|
1156
1523
|
<dl>
|
|
@@ -1203,6 +1570,23 @@ await client.domains.create({
|
|
|
1203
1570
|
<dl>
|
|
1204
1571
|
<dd>
|
|
1205
1572
|
|
|
1573
|
+
#### 📝 Description
|
|
1574
|
+
|
|
1575
|
+
<dl>
|
|
1576
|
+
<dd>
|
|
1577
|
+
|
|
1578
|
+
<dl>
|
|
1579
|
+
<dd>
|
|
1580
|
+
|
|
1581
|
+
**CLI:**
|
|
1582
|
+
```bash
|
|
1583
|
+
agentmail domains update --domain-id <domain_id>
|
|
1584
|
+
```
|
|
1585
|
+
</dd>
|
|
1586
|
+
</dl>
|
|
1587
|
+
</dd>
|
|
1588
|
+
</dl>
|
|
1589
|
+
|
|
1206
1590
|
#### 🔌 Usage
|
|
1207
1591
|
|
|
1208
1592
|
<dl>
|
|
@@ -1260,6 +1644,23 @@ await client.domains.update("domain_id", {});
|
|
|
1260
1644
|
<dl>
|
|
1261
1645
|
<dd>
|
|
1262
1646
|
|
|
1647
|
+
#### 📝 Description
|
|
1648
|
+
|
|
1649
|
+
<dl>
|
|
1650
|
+
<dd>
|
|
1651
|
+
|
|
1652
|
+
<dl>
|
|
1653
|
+
<dd>
|
|
1654
|
+
|
|
1655
|
+
**CLI:**
|
|
1656
|
+
```bash
|
|
1657
|
+
agentmail domains delete --domain-id <domain_id>
|
|
1658
|
+
```
|
|
1659
|
+
</dd>
|
|
1660
|
+
</dl>
|
|
1661
|
+
</dd>
|
|
1662
|
+
</dl>
|
|
1663
|
+
|
|
1263
1664
|
#### 🔌 Usage
|
|
1264
1665
|
|
|
1265
1666
|
<dl>
|
|
@@ -1309,6 +1710,23 @@ await client.domains.delete("domain_id");
|
|
|
1309
1710
|
<dl>
|
|
1310
1711
|
<dd>
|
|
1311
1712
|
|
|
1713
|
+
#### 📝 Description
|
|
1714
|
+
|
|
1715
|
+
<dl>
|
|
1716
|
+
<dd>
|
|
1717
|
+
|
|
1718
|
+
<dl>
|
|
1719
|
+
<dd>
|
|
1720
|
+
|
|
1721
|
+
**CLI:**
|
|
1722
|
+
```bash
|
|
1723
|
+
agentmail domains verify --domain-id <domain_id>
|
|
1724
|
+
```
|
|
1725
|
+
</dd>
|
|
1726
|
+
</dl>
|
|
1727
|
+
</dd>
|
|
1728
|
+
</dl>
|
|
1729
|
+
|
|
1312
1730
|
#### 🔌 Usage
|
|
1313
1731
|
|
|
1314
1732
|
<dl>
|
|
@@ -1359,6 +1777,23 @@ await client.domains.verify("domain_id");
|
|
|
1359
1777
|
<dl>
|
|
1360
1778
|
<dd>
|
|
1361
1779
|
|
|
1780
|
+
#### 📝 Description
|
|
1781
|
+
|
|
1782
|
+
<dl>
|
|
1783
|
+
<dd>
|
|
1784
|
+
|
|
1785
|
+
<dl>
|
|
1786
|
+
<dd>
|
|
1787
|
+
|
|
1788
|
+
**CLI:**
|
|
1789
|
+
```bash
|
|
1790
|
+
agentmail drafts list
|
|
1791
|
+
```
|
|
1792
|
+
</dd>
|
|
1793
|
+
</dl>
|
|
1794
|
+
</dd>
|
|
1795
|
+
</dl>
|
|
1796
|
+
|
|
1362
1797
|
#### 🔌 Usage
|
|
1363
1798
|
|
|
1364
1799
|
<dl>
|
|
@@ -1408,6 +1843,23 @@ await client.drafts.list();
|
|
|
1408
1843
|
<dl>
|
|
1409
1844
|
<dd>
|
|
1410
1845
|
|
|
1846
|
+
#### 📝 Description
|
|
1847
|
+
|
|
1848
|
+
<dl>
|
|
1849
|
+
<dd>
|
|
1850
|
+
|
|
1851
|
+
<dl>
|
|
1852
|
+
<dd>
|
|
1853
|
+
|
|
1854
|
+
**CLI:**
|
|
1855
|
+
```bash
|
|
1856
|
+
agentmail drafts retrieve --draft-id <draft_id>
|
|
1857
|
+
```
|
|
1858
|
+
</dd>
|
|
1859
|
+
</dl>
|
|
1860
|
+
</dd>
|
|
1861
|
+
</dl>
|
|
1862
|
+
|
|
1411
1863
|
#### 🔌 Usage
|
|
1412
1864
|
|
|
1413
1865
|
<dl>
|
|
@@ -1457,6 +1909,23 @@ await client.drafts.get("draft_id");
|
|
|
1457
1909
|
<dl>
|
|
1458
1910
|
<dd>
|
|
1459
1911
|
|
|
1912
|
+
#### 📝 Description
|
|
1913
|
+
|
|
1914
|
+
<dl>
|
|
1915
|
+
<dd>
|
|
1916
|
+
|
|
1917
|
+
<dl>
|
|
1918
|
+
<dd>
|
|
1919
|
+
|
|
1920
|
+
**CLI:**
|
|
1921
|
+
```bash
|
|
1922
|
+
agentmail drafts get-attachment --draft-id <draft_id> --attachment-id <attachment_id>
|
|
1923
|
+
```
|
|
1924
|
+
</dd>
|
|
1925
|
+
</dl>
|
|
1926
|
+
</dd>
|
|
1927
|
+
</dl>
|
|
1928
|
+
|
|
1460
1929
|
#### 🔌 Usage
|
|
1461
1930
|
|
|
1462
1931
|
<dl>
|
|
@@ -1515,6 +1984,23 @@ await client.drafts.getAttachment("draft_id", "attachment_id");
|
|
|
1515
1984
|
<dl>
|
|
1516
1985
|
<dd>
|
|
1517
1986
|
|
|
1987
|
+
#### 📝 Description
|
|
1988
|
+
|
|
1989
|
+
<dl>
|
|
1990
|
+
<dd>
|
|
1991
|
+
|
|
1992
|
+
<dl>
|
|
1993
|
+
<dd>
|
|
1994
|
+
|
|
1995
|
+
**CLI:**
|
|
1996
|
+
```bash
|
|
1997
|
+
agentmail inboxes:api-keys list --inbox-id <inbox_id>
|
|
1998
|
+
```
|
|
1999
|
+
</dd>
|
|
2000
|
+
</dl>
|
|
2001
|
+
</dd>
|
|
2002
|
+
</dl>
|
|
2003
|
+
|
|
1518
2004
|
#### 🔌 Usage
|
|
1519
2005
|
|
|
1520
2006
|
<dl>
|
|
@@ -1572,6 +2058,23 @@ await client.inboxes.apiKeys.list("inbox_id");
|
|
|
1572
2058
|
<dl>
|
|
1573
2059
|
<dd>
|
|
1574
2060
|
|
|
2061
|
+
#### 📝 Description
|
|
2062
|
+
|
|
2063
|
+
<dl>
|
|
2064
|
+
<dd>
|
|
2065
|
+
|
|
2066
|
+
<dl>
|
|
2067
|
+
<dd>
|
|
2068
|
+
|
|
2069
|
+
**CLI:**
|
|
2070
|
+
```bash
|
|
2071
|
+
agentmail inboxes:api-keys create --inbox-id <inbox_id> --name "My Key"
|
|
2072
|
+
```
|
|
2073
|
+
</dd>
|
|
2074
|
+
</dl>
|
|
2075
|
+
</dd>
|
|
2076
|
+
</dl>
|
|
2077
|
+
|
|
1575
2078
|
#### 🔌 Usage
|
|
1576
2079
|
|
|
1577
2080
|
<dl>
|
|
@@ -1581,9 +2084,7 @@ await client.inboxes.apiKeys.list("inbox_id");
|
|
|
1581
2084
|
<dd>
|
|
1582
2085
|
|
|
1583
2086
|
```typescript
|
|
1584
|
-
await client.inboxes.apiKeys.create("inbox_id", {
|
|
1585
|
-
name: "name"
|
|
1586
|
-
});
|
|
2087
|
+
await client.inboxes.apiKeys.create("inbox_id", {});
|
|
1587
2088
|
|
|
1588
2089
|
```
|
|
1589
2090
|
</dd>
|
|
@@ -1631,6 +2132,23 @@ await client.inboxes.apiKeys.create("inbox_id", {
|
|
|
1631
2132
|
<dl>
|
|
1632
2133
|
<dd>
|
|
1633
2134
|
|
|
2135
|
+
#### 📝 Description
|
|
2136
|
+
|
|
2137
|
+
<dl>
|
|
2138
|
+
<dd>
|
|
2139
|
+
|
|
2140
|
+
<dl>
|
|
2141
|
+
<dd>
|
|
2142
|
+
|
|
2143
|
+
**CLI:**
|
|
2144
|
+
```bash
|
|
2145
|
+
agentmail inboxes:api-keys delete --inbox-id <inbox_id> --api-key-id <api_key_id>
|
|
2146
|
+
```
|
|
2147
|
+
</dd>
|
|
2148
|
+
</dl>
|
|
2149
|
+
</dd>
|
|
2150
|
+
</dl>
|
|
2151
|
+
|
|
1634
2152
|
#### 🔌 Usage
|
|
1635
2153
|
|
|
1636
2154
|
<dl>
|
|
@@ -1689,6 +2207,23 @@ await client.inboxes.apiKeys.delete("inbox_id", "api_key_id");
|
|
|
1689
2207
|
<dl>
|
|
1690
2208
|
<dd>
|
|
1691
2209
|
|
|
2210
|
+
#### 📝 Description
|
|
2211
|
+
|
|
2212
|
+
<dl>
|
|
2213
|
+
<dd>
|
|
2214
|
+
|
|
2215
|
+
<dl>
|
|
2216
|
+
<dd>
|
|
2217
|
+
|
|
2218
|
+
**CLI:**
|
|
2219
|
+
```bash
|
|
2220
|
+
agentmail inboxes:drafts list --inbox-id <inbox_id>
|
|
2221
|
+
```
|
|
2222
|
+
</dd>
|
|
2223
|
+
</dl>
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
|
|
1692
2227
|
#### 🔌 Usage
|
|
1693
2228
|
|
|
1694
2229
|
<dl>
|
|
@@ -1746,6 +2281,23 @@ await client.inboxes.drafts.list("inbox_id");
|
|
|
1746
2281
|
<dl>
|
|
1747
2282
|
<dd>
|
|
1748
2283
|
|
|
2284
|
+
#### 📝 Description
|
|
2285
|
+
|
|
2286
|
+
<dl>
|
|
2287
|
+
<dd>
|
|
2288
|
+
|
|
2289
|
+
<dl>
|
|
2290
|
+
<dd>
|
|
2291
|
+
|
|
2292
|
+
**CLI:**
|
|
2293
|
+
```bash
|
|
2294
|
+
agentmail inboxes:drafts retrieve --inbox-id <inbox_id> --draft-id <draft_id>
|
|
2295
|
+
```
|
|
2296
|
+
</dd>
|
|
2297
|
+
</dl>
|
|
2298
|
+
</dd>
|
|
2299
|
+
</dl>
|
|
2300
|
+
|
|
1749
2301
|
#### 🔌 Usage
|
|
1750
2302
|
|
|
1751
2303
|
<dl>
|
|
@@ -1803,6 +2355,23 @@ await client.inboxes.drafts.get("inbox_id", "draft_id");
|
|
|
1803
2355
|
<dl>
|
|
1804
2356
|
<dd>
|
|
1805
2357
|
|
|
2358
|
+
#### 📝 Description
|
|
2359
|
+
|
|
2360
|
+
<dl>
|
|
2361
|
+
<dd>
|
|
2362
|
+
|
|
2363
|
+
<dl>
|
|
2364
|
+
<dd>
|
|
2365
|
+
|
|
2366
|
+
**CLI:**
|
|
2367
|
+
```bash
|
|
2368
|
+
agentmail inboxes:drafts get-attachment --inbox-id <inbox_id> --draft-id <draft_id> --attachment-id <attachment_id>
|
|
2369
|
+
```
|
|
2370
|
+
</dd>
|
|
2371
|
+
</dl>
|
|
2372
|
+
</dd>
|
|
2373
|
+
</dl>
|
|
2374
|
+
|
|
1806
2375
|
#### 🔌 Usage
|
|
1807
2376
|
|
|
1808
2377
|
<dl>
|
|
@@ -1862,11 +2431,28 @@ await client.inboxes.drafts.getAttachment("inbox_id", "draft_id", "attachment_id
|
|
|
1862
2431
|
|
|
1863
2432
|
</dd>
|
|
1864
2433
|
</dl>
|
|
1865
|
-
</details>
|
|
1866
|
-
|
|
1867
|
-
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">create</a>(inbox_id, { ...params }) -> AgentMail.Draft</code></summary>
|
|
1868
|
-
<dl>
|
|
1869
|
-
<dd>
|
|
2434
|
+
</details>
|
|
2435
|
+
|
|
2436
|
+
<details><summary><code>client.inboxes.drafts.<a href="/src/api/resources/inboxes/resources/drafts/client/Client.ts">create</a>(inbox_id, { ...params }) -> AgentMail.Draft</code></summary>
|
|
2437
|
+
<dl>
|
|
2438
|
+
<dd>
|
|
2439
|
+
|
|
2440
|
+
#### 📝 Description
|
|
2441
|
+
|
|
2442
|
+
<dl>
|
|
2443
|
+
<dd>
|
|
2444
|
+
|
|
2445
|
+
<dl>
|
|
2446
|
+
<dd>
|
|
2447
|
+
|
|
2448
|
+
**CLI:**
|
|
2449
|
+
```bash
|
|
2450
|
+
agentmail inboxes:drafts create --inbox-id <inbox_id> --to recipient@example.com --subject "Draft subject" --text "Draft body"
|
|
2451
|
+
```
|
|
2452
|
+
</dd>
|
|
2453
|
+
</dl>
|
|
2454
|
+
</dd>
|
|
2455
|
+
</dl>
|
|
1870
2456
|
|
|
1871
2457
|
#### 🔌 Usage
|
|
1872
2458
|
|
|
@@ -1925,6 +2511,23 @@ await client.inboxes.drafts.create("inbox_id", {});
|
|
|
1925
2511
|
<dl>
|
|
1926
2512
|
<dd>
|
|
1927
2513
|
|
|
2514
|
+
#### 📝 Description
|
|
2515
|
+
|
|
2516
|
+
<dl>
|
|
2517
|
+
<dd>
|
|
2518
|
+
|
|
2519
|
+
<dl>
|
|
2520
|
+
<dd>
|
|
2521
|
+
|
|
2522
|
+
**CLI:**
|
|
2523
|
+
```bash
|
|
2524
|
+
agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"
|
|
2525
|
+
```
|
|
2526
|
+
</dd>
|
|
2527
|
+
</dl>
|
|
2528
|
+
</dd>
|
|
2529
|
+
</dl>
|
|
2530
|
+
|
|
1928
2531
|
#### 🔌 Usage
|
|
1929
2532
|
|
|
1930
2533
|
<dl>
|
|
@@ -1990,6 +2593,23 @@ await client.inboxes.drafts.update("inbox_id", "draft_id", {});
|
|
|
1990
2593
|
<dl>
|
|
1991
2594
|
<dd>
|
|
1992
2595
|
|
|
2596
|
+
#### 📝 Description
|
|
2597
|
+
|
|
2598
|
+
<dl>
|
|
2599
|
+
<dd>
|
|
2600
|
+
|
|
2601
|
+
<dl>
|
|
2602
|
+
<dd>
|
|
2603
|
+
|
|
2604
|
+
**CLI:**
|
|
2605
|
+
```bash
|
|
2606
|
+
agentmail inboxes:drafts delete --inbox-id <inbox_id> --draft-id <draft_id>
|
|
2607
|
+
```
|
|
2608
|
+
</dd>
|
|
2609
|
+
</dl>
|
|
2610
|
+
</dd>
|
|
2611
|
+
</dl>
|
|
2612
|
+
|
|
1993
2613
|
#### 🔌 Usage
|
|
1994
2614
|
|
|
1995
2615
|
<dl>
|
|
@@ -2047,6 +2667,23 @@ await client.inboxes.drafts.delete("inbox_id", "draft_id");
|
|
|
2047
2667
|
<dl>
|
|
2048
2668
|
<dd>
|
|
2049
2669
|
|
|
2670
|
+
#### 📝 Description
|
|
2671
|
+
|
|
2672
|
+
<dl>
|
|
2673
|
+
<dd>
|
|
2674
|
+
|
|
2675
|
+
<dl>
|
|
2676
|
+
<dd>
|
|
2677
|
+
|
|
2678
|
+
**CLI:**
|
|
2679
|
+
```bash
|
|
2680
|
+
agentmail inboxes:drafts send --inbox-id <inbox_id> --draft-id <draft_id>
|
|
2681
|
+
```
|
|
2682
|
+
</dd>
|
|
2683
|
+
</dl>
|
|
2684
|
+
</dd>
|
|
2685
|
+
</dl>
|
|
2686
|
+
|
|
2050
2687
|
#### 🔌 Usage
|
|
2051
2688
|
|
|
2052
2689
|
<dl>
|
|
@@ -2113,6 +2750,23 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
|
2113
2750
|
<dl>
|
|
2114
2751
|
<dd>
|
|
2115
2752
|
|
|
2753
|
+
#### 📝 Description
|
|
2754
|
+
|
|
2755
|
+
<dl>
|
|
2756
|
+
<dd>
|
|
2757
|
+
|
|
2758
|
+
<dl>
|
|
2759
|
+
<dd>
|
|
2760
|
+
|
|
2761
|
+
**CLI:**
|
|
2762
|
+
```bash
|
|
2763
|
+
agentmail inboxes:lists list --inbox-id <inbox_id> --direction <direction> --type <type>
|
|
2764
|
+
```
|
|
2765
|
+
</dd>
|
|
2766
|
+
</dl>
|
|
2767
|
+
</dd>
|
|
2768
|
+
</dl>
|
|
2769
|
+
|
|
2116
2770
|
#### 🔌 Usage
|
|
2117
2771
|
|
|
2118
2772
|
<dl>
|
|
@@ -2186,6 +2840,23 @@ await client.inboxes.lists.list("inbox_id", "send", "allow");
|
|
|
2186
2840
|
<dl>
|
|
2187
2841
|
<dd>
|
|
2188
2842
|
|
|
2843
|
+
#### 📝 Description
|
|
2844
|
+
|
|
2845
|
+
<dl>
|
|
2846
|
+
<dd>
|
|
2847
|
+
|
|
2848
|
+
<dl>
|
|
2849
|
+
<dd>
|
|
2850
|
+
|
|
2851
|
+
**CLI:**
|
|
2852
|
+
```bash
|
|
2853
|
+
agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
|
|
2854
|
+
```
|
|
2855
|
+
</dd>
|
|
2856
|
+
</dl>
|
|
2857
|
+
</dd>
|
|
2858
|
+
</dl>
|
|
2859
|
+
|
|
2189
2860
|
#### 🔌 Usage
|
|
2190
2861
|
|
|
2191
2862
|
<dl>
|
|
@@ -2259,6 +2930,23 @@ await client.inboxes.lists.get("inbox_id", "send", "allow", "entry");
|
|
|
2259
2930
|
<dl>
|
|
2260
2931
|
<dd>
|
|
2261
2932
|
|
|
2933
|
+
#### 📝 Description
|
|
2934
|
+
|
|
2935
|
+
<dl>
|
|
2936
|
+
<dd>
|
|
2937
|
+
|
|
2938
|
+
<dl>
|
|
2939
|
+
<dd>
|
|
2940
|
+
|
|
2941
|
+
**CLI:**
|
|
2942
|
+
```bash
|
|
2943
|
+
agentmail inboxes:lists create --inbox-id <inbox_id> --direction <direction> --type <type> --entry user@example.com
|
|
2944
|
+
```
|
|
2945
|
+
</dd>
|
|
2946
|
+
</dl>
|
|
2947
|
+
</dd>
|
|
2948
|
+
</dl>
|
|
2949
|
+
|
|
2262
2950
|
#### 🔌 Usage
|
|
2263
2951
|
|
|
2264
2952
|
<dl>
|
|
@@ -2334,6 +3022,23 @@ await client.inboxes.lists.create("inbox_id", "send", "allow", {
|
|
|
2334
3022
|
<dl>
|
|
2335
3023
|
<dd>
|
|
2336
3024
|
|
|
3025
|
+
#### 📝 Description
|
|
3026
|
+
|
|
3027
|
+
<dl>
|
|
3028
|
+
<dd>
|
|
3029
|
+
|
|
3030
|
+
<dl>
|
|
3031
|
+
<dd>
|
|
3032
|
+
|
|
3033
|
+
**CLI:**
|
|
3034
|
+
```bash
|
|
3035
|
+
agentmail inboxes:lists delete --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>
|
|
3036
|
+
```
|
|
3037
|
+
</dd>
|
|
3038
|
+
</dl>
|
|
3039
|
+
</dd>
|
|
3040
|
+
</dl>
|
|
3041
|
+
|
|
2337
3042
|
#### 🔌 Usage
|
|
2338
3043
|
|
|
2339
3044
|
<dl>
|
|
@@ -2408,6 +3113,23 @@ await client.inboxes.lists.delete("inbox_id", "send", "allow", "entry");
|
|
|
2408
3113
|
<dl>
|
|
2409
3114
|
<dd>
|
|
2410
3115
|
|
|
3116
|
+
#### 📝 Description
|
|
3117
|
+
|
|
3118
|
+
<dl>
|
|
3119
|
+
<dd>
|
|
3120
|
+
|
|
3121
|
+
<dl>
|
|
3122
|
+
<dd>
|
|
3123
|
+
|
|
3124
|
+
**CLI:**
|
|
3125
|
+
```bash
|
|
3126
|
+
agentmail inboxes:messages list --inbox-id <inbox_id>
|
|
3127
|
+
```
|
|
3128
|
+
</dd>
|
|
3129
|
+
</dl>
|
|
3130
|
+
</dd>
|
|
3131
|
+
</dl>
|
|
3132
|
+
|
|
2411
3133
|
#### 🔌 Usage
|
|
2412
3134
|
|
|
2413
3135
|
<dl>
|
|
@@ -2465,6 +3187,23 @@ await client.inboxes.messages.list("inbox_id");
|
|
|
2465
3187
|
<dl>
|
|
2466
3188
|
<dd>
|
|
2467
3189
|
|
|
3190
|
+
#### 📝 Description
|
|
3191
|
+
|
|
3192
|
+
<dl>
|
|
3193
|
+
<dd>
|
|
3194
|
+
|
|
3195
|
+
<dl>
|
|
3196
|
+
<dd>
|
|
3197
|
+
|
|
3198
|
+
**CLI:**
|
|
3199
|
+
```bash
|
|
3200
|
+
agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id <message_id>
|
|
3201
|
+
```
|
|
3202
|
+
</dd>
|
|
3203
|
+
</dl>
|
|
3204
|
+
</dd>
|
|
3205
|
+
</dl>
|
|
3206
|
+
|
|
2468
3207
|
#### 🔌 Usage
|
|
2469
3208
|
|
|
2470
3209
|
<dl>
|
|
@@ -2522,6 +3261,23 @@ await client.inboxes.messages.get("inbox_id", "message_id");
|
|
|
2522
3261
|
<dl>
|
|
2523
3262
|
<dd>
|
|
2524
3263
|
|
|
3264
|
+
#### 📝 Description
|
|
3265
|
+
|
|
3266
|
+
<dl>
|
|
3267
|
+
<dd>
|
|
3268
|
+
|
|
3269
|
+
<dl>
|
|
3270
|
+
<dd>
|
|
3271
|
+
|
|
3272
|
+
**CLI:**
|
|
3273
|
+
```bash
|
|
3274
|
+
agentmail inboxes:messages get-attachment --inbox-id <inbox_id> --message-id <message_id> --attachment-id <attachment_id>
|
|
3275
|
+
```
|
|
3276
|
+
</dd>
|
|
3277
|
+
</dl>
|
|
3278
|
+
</dd>
|
|
3279
|
+
</dl>
|
|
3280
|
+
|
|
2525
3281
|
#### 🔌 Usage
|
|
2526
3282
|
|
|
2527
3283
|
<dl>
|
|
@@ -2587,6 +3343,23 @@ await client.inboxes.messages.getAttachment("inbox_id", "message_id", "attachmen
|
|
|
2587
3343
|
<dl>
|
|
2588
3344
|
<dd>
|
|
2589
3345
|
|
|
3346
|
+
#### 📝 Description
|
|
3347
|
+
|
|
3348
|
+
<dl>
|
|
3349
|
+
<dd>
|
|
3350
|
+
|
|
3351
|
+
<dl>
|
|
3352
|
+
<dd>
|
|
3353
|
+
|
|
3354
|
+
**CLI:**
|
|
3355
|
+
```bash
|
|
3356
|
+
agentmail inboxes:messages get-raw --inbox-id <inbox_id> --message-id <message_id>
|
|
3357
|
+
```
|
|
3358
|
+
</dd>
|
|
3359
|
+
</dl>
|
|
3360
|
+
</dd>
|
|
3361
|
+
</dl>
|
|
3362
|
+
|
|
2590
3363
|
#### 🔌 Usage
|
|
2591
3364
|
|
|
2592
3365
|
<dl>
|
|
@@ -2644,6 +3417,23 @@ await client.inboxes.messages.getRaw("inbox_id", "message_id");
|
|
|
2644
3417
|
<dl>
|
|
2645
3418
|
<dd>
|
|
2646
3419
|
|
|
3420
|
+
#### 📝 Description
|
|
3421
|
+
|
|
3422
|
+
<dl>
|
|
3423
|
+
<dd>
|
|
3424
|
+
|
|
3425
|
+
<dl>
|
|
3426
|
+
<dd>
|
|
3427
|
+
|
|
3428
|
+
**CLI:**
|
|
3429
|
+
```bash
|
|
3430
|
+
agentmail inboxes:messages update --inbox-id <inbox_id> --message-id <message_id> --add-label read --remove-label unread
|
|
3431
|
+
```
|
|
3432
|
+
</dd>
|
|
3433
|
+
</dl>
|
|
3434
|
+
</dd>
|
|
3435
|
+
</dl>
|
|
3436
|
+
|
|
2647
3437
|
#### 🔌 Usage
|
|
2648
3438
|
|
|
2649
3439
|
<dl>
|
|
@@ -2709,6 +3499,23 @@ await client.inboxes.messages.update("inbox_id", "message_id", {});
|
|
|
2709
3499
|
<dl>
|
|
2710
3500
|
<dd>
|
|
2711
3501
|
|
|
3502
|
+
#### 📝 Description
|
|
3503
|
+
|
|
3504
|
+
<dl>
|
|
3505
|
+
<dd>
|
|
3506
|
+
|
|
3507
|
+
<dl>
|
|
3508
|
+
<dd>
|
|
3509
|
+
|
|
3510
|
+
**CLI:**
|
|
3511
|
+
```bash
|
|
3512
|
+
agentmail inboxes:messages send --inbox-id <inbox_id> --to recipient@example.com --subject "Hello" --text "Body"
|
|
3513
|
+
```
|
|
3514
|
+
</dd>
|
|
3515
|
+
</dl>
|
|
3516
|
+
</dd>
|
|
3517
|
+
</dl>
|
|
3518
|
+
|
|
2712
3519
|
#### 🔌 Usage
|
|
2713
3520
|
|
|
2714
3521
|
<dl>
|
|
@@ -2766,6 +3573,23 @@ await client.inboxes.messages.send("inbox_id", {});
|
|
|
2766
3573
|
<dl>
|
|
2767
3574
|
<dd>
|
|
2768
3575
|
|
|
3576
|
+
#### 📝 Description
|
|
3577
|
+
|
|
3578
|
+
<dl>
|
|
3579
|
+
<dd>
|
|
3580
|
+
|
|
3581
|
+
<dl>
|
|
3582
|
+
<dd>
|
|
3583
|
+
|
|
3584
|
+
**CLI:**
|
|
3585
|
+
```bash
|
|
3586
|
+
agentmail inboxes:messages reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
3587
|
+
```
|
|
3588
|
+
</dd>
|
|
3589
|
+
</dl>
|
|
3590
|
+
</dd>
|
|
3591
|
+
</dl>
|
|
3592
|
+
|
|
2769
3593
|
#### 🔌 Usage
|
|
2770
3594
|
|
|
2771
3595
|
<dl>
|
|
@@ -2831,6 +3655,23 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {});
|
|
|
2831
3655
|
<dl>
|
|
2832
3656
|
<dd>
|
|
2833
3657
|
|
|
3658
|
+
#### 📝 Description
|
|
3659
|
+
|
|
3660
|
+
<dl>
|
|
3661
|
+
<dd>
|
|
3662
|
+
|
|
3663
|
+
<dl>
|
|
3664
|
+
<dd>
|
|
3665
|
+
|
|
3666
|
+
**CLI:**
|
|
3667
|
+
```bash
|
|
3668
|
+
agentmail inboxes:messages reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
3669
|
+
```
|
|
3670
|
+
</dd>
|
|
3671
|
+
</dl>
|
|
3672
|
+
</dd>
|
|
3673
|
+
</dl>
|
|
3674
|
+
|
|
2834
3675
|
#### 🔌 Usage
|
|
2835
3676
|
|
|
2836
3677
|
<dl>
|
|
@@ -2896,6 +3737,23 @@ await client.inboxes.messages.replyAll("inbox_id", "message_id", {});
|
|
|
2896
3737
|
<dl>
|
|
2897
3738
|
<dd>
|
|
2898
3739
|
|
|
3740
|
+
#### 📝 Description
|
|
3741
|
+
|
|
3742
|
+
<dl>
|
|
3743
|
+
<dd>
|
|
3744
|
+
|
|
3745
|
+
<dl>
|
|
3746
|
+
<dd>
|
|
3747
|
+
|
|
3748
|
+
**CLI:**
|
|
3749
|
+
```bash
|
|
3750
|
+
agentmail inboxes:messages forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
|
|
3751
|
+
```
|
|
3752
|
+
</dd>
|
|
3753
|
+
</dl>
|
|
3754
|
+
</dd>
|
|
3755
|
+
</dl>
|
|
3756
|
+
|
|
2899
3757
|
#### 🔌 Usage
|
|
2900
3758
|
|
|
2901
3759
|
<dl>
|
|
@@ -2962,6 +3820,23 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
2962
3820
|
<dl>
|
|
2963
3821
|
<dd>
|
|
2964
3822
|
|
|
3823
|
+
#### 📝 Description
|
|
3824
|
+
|
|
3825
|
+
<dl>
|
|
3826
|
+
<dd>
|
|
3827
|
+
|
|
3828
|
+
<dl>
|
|
3829
|
+
<dd>
|
|
3830
|
+
|
|
3831
|
+
**CLI:**
|
|
3832
|
+
```bash
|
|
3833
|
+
agentmail inboxes:metrics query --inbox-id <inbox_id>
|
|
3834
|
+
```
|
|
3835
|
+
</dd>
|
|
3836
|
+
</dl>
|
|
3837
|
+
</dd>
|
|
3838
|
+
</dl>
|
|
3839
|
+
|
|
2965
3840
|
#### 🔌 Usage
|
|
2966
3841
|
|
|
2967
3842
|
<dl>
|
|
@@ -3020,6 +3895,23 @@ await client.inboxes.metrics.query("inbox_id");
|
|
|
3020
3895
|
<dl>
|
|
3021
3896
|
<dd>
|
|
3022
3897
|
|
|
3898
|
+
#### 📝 Description
|
|
3899
|
+
|
|
3900
|
+
<dl>
|
|
3901
|
+
<dd>
|
|
3902
|
+
|
|
3903
|
+
<dl>
|
|
3904
|
+
<dd>
|
|
3905
|
+
|
|
3906
|
+
**CLI:**
|
|
3907
|
+
```bash
|
|
3908
|
+
agentmail inboxes:threads list --inbox-id <inbox_id>
|
|
3909
|
+
```
|
|
3910
|
+
</dd>
|
|
3911
|
+
</dl>
|
|
3912
|
+
</dd>
|
|
3913
|
+
</dl>
|
|
3914
|
+
|
|
3023
3915
|
#### 🔌 Usage
|
|
3024
3916
|
|
|
3025
3917
|
<dl>
|
|
@@ -3077,6 +3969,23 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
3077
3969
|
<dl>
|
|
3078
3970
|
<dd>
|
|
3079
3971
|
|
|
3972
|
+
#### 📝 Description
|
|
3973
|
+
|
|
3974
|
+
<dl>
|
|
3975
|
+
<dd>
|
|
3976
|
+
|
|
3977
|
+
<dl>
|
|
3978
|
+
<dd>
|
|
3979
|
+
|
|
3980
|
+
**CLI:**
|
|
3981
|
+
```bash
|
|
3982
|
+
agentmail inboxes:threads retrieve --inbox-id <inbox_id> --thread-id <thread_id>
|
|
3983
|
+
```
|
|
3984
|
+
</dd>
|
|
3985
|
+
</dl>
|
|
3986
|
+
</dd>
|
|
3987
|
+
</dl>
|
|
3988
|
+
|
|
3080
3989
|
#### 🔌 Usage
|
|
3081
3990
|
|
|
3082
3991
|
<dl>
|
|
@@ -3134,6 +4043,23 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
3134
4043
|
<dl>
|
|
3135
4044
|
<dd>
|
|
3136
4045
|
|
|
4046
|
+
#### 📝 Description
|
|
4047
|
+
|
|
4048
|
+
<dl>
|
|
4049
|
+
<dd>
|
|
4050
|
+
|
|
4051
|
+
<dl>
|
|
4052
|
+
<dd>
|
|
4053
|
+
|
|
4054
|
+
**CLI:**
|
|
4055
|
+
```bash
|
|
4056
|
+
agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
4057
|
+
```
|
|
4058
|
+
</dd>
|
|
4059
|
+
</dl>
|
|
4060
|
+
</dd>
|
|
4061
|
+
</dl>
|
|
4062
|
+
|
|
3137
4063
|
#### 🔌 Usage
|
|
3138
4064
|
|
|
3139
4065
|
<dl>
|
|
@@ -3287,6 +4213,11 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
3287
4213
|
<dd>
|
|
3288
4214
|
|
|
3289
4215
|
Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
4216
|
+
|
|
4217
|
+
**CLI:**
|
|
4218
|
+
```bash
|
|
4219
|
+
agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
|
|
4220
|
+
```
|
|
3290
4221
|
</dd>
|
|
3291
4222
|
</dl>
|
|
3292
4223
|
</dd>
|
|
@@ -3358,6 +4289,23 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
3358
4289
|
<dl>
|
|
3359
4290
|
<dd>
|
|
3360
4291
|
|
|
4292
|
+
#### 📝 Description
|
|
4293
|
+
|
|
4294
|
+
<dl>
|
|
4295
|
+
<dd>
|
|
4296
|
+
|
|
4297
|
+
<dl>
|
|
4298
|
+
<dd>
|
|
4299
|
+
|
|
4300
|
+
**CLI:**
|
|
4301
|
+
```bash
|
|
4302
|
+
agentmail lists list --direction <direction> --type <type>
|
|
4303
|
+
```
|
|
4304
|
+
</dd>
|
|
4305
|
+
</dl>
|
|
4306
|
+
</dd>
|
|
4307
|
+
</dl>
|
|
4308
|
+
|
|
3361
4309
|
#### 🔌 Usage
|
|
3362
4310
|
|
|
3363
4311
|
<dl>
|
|
@@ -3423,6 +4371,23 @@ await client.lists.list("send", "allow");
|
|
|
3423
4371
|
<dl>
|
|
3424
4372
|
<dd>
|
|
3425
4373
|
|
|
4374
|
+
#### 📝 Description
|
|
4375
|
+
|
|
4376
|
+
<dl>
|
|
4377
|
+
<dd>
|
|
4378
|
+
|
|
4379
|
+
<dl>
|
|
4380
|
+
<dd>
|
|
4381
|
+
|
|
4382
|
+
**CLI:**
|
|
4383
|
+
```bash
|
|
4384
|
+
agentmail lists retrieve --direction <direction> --type <type> --entry <entry>
|
|
4385
|
+
```
|
|
4386
|
+
</dd>
|
|
4387
|
+
</dl>
|
|
4388
|
+
</dd>
|
|
4389
|
+
</dl>
|
|
4390
|
+
|
|
3426
4391
|
#### 🔌 Usage
|
|
3427
4392
|
|
|
3428
4393
|
<dl>
|
|
@@ -3488,6 +4453,23 @@ await client.lists.get("send", "allow", "entry");
|
|
|
3488
4453
|
<dl>
|
|
3489
4454
|
<dd>
|
|
3490
4455
|
|
|
4456
|
+
#### 📝 Description
|
|
4457
|
+
|
|
4458
|
+
<dl>
|
|
4459
|
+
<dd>
|
|
4460
|
+
|
|
4461
|
+
<dl>
|
|
4462
|
+
<dd>
|
|
4463
|
+
|
|
4464
|
+
**CLI:**
|
|
4465
|
+
```bash
|
|
4466
|
+
agentmail lists create --direction <direction> --type <type> --entry user@example.com
|
|
4467
|
+
```
|
|
4468
|
+
</dd>
|
|
4469
|
+
</dl>
|
|
4470
|
+
</dd>
|
|
4471
|
+
</dl>
|
|
4472
|
+
|
|
3491
4473
|
#### 🔌 Usage
|
|
3492
4474
|
|
|
3493
4475
|
<dl>
|
|
@@ -3555,6 +4537,23 @@ await client.lists.create("send", "allow", {
|
|
|
3555
4537
|
<dl>
|
|
3556
4538
|
<dd>
|
|
3557
4539
|
|
|
4540
|
+
#### 📝 Description
|
|
4541
|
+
|
|
4542
|
+
<dl>
|
|
4543
|
+
<dd>
|
|
4544
|
+
|
|
4545
|
+
<dl>
|
|
4546
|
+
<dd>
|
|
4547
|
+
|
|
4548
|
+
**CLI:**
|
|
4549
|
+
```bash
|
|
4550
|
+
agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
4551
|
+
```
|
|
4552
|
+
</dd>
|
|
4553
|
+
</dl>
|
|
4554
|
+
</dd>
|
|
4555
|
+
</dl>
|
|
4556
|
+
|
|
3558
4557
|
#### 🔌 Usage
|
|
3559
4558
|
|
|
3560
4559
|
<dl>
|
|
@@ -3621,6 +4620,23 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
3621
4620
|
<dl>
|
|
3622
4621
|
<dd>
|
|
3623
4622
|
|
|
4623
|
+
#### 📝 Description
|
|
4624
|
+
|
|
4625
|
+
<dl>
|
|
4626
|
+
<dd>
|
|
4627
|
+
|
|
4628
|
+
<dl>
|
|
4629
|
+
<dd>
|
|
4630
|
+
|
|
4631
|
+
**CLI:**
|
|
4632
|
+
```bash
|
|
4633
|
+
agentmail metrics list
|
|
4634
|
+
```
|
|
4635
|
+
</dd>
|
|
4636
|
+
</dl>
|
|
4637
|
+
</dd>
|
|
4638
|
+
</dl>
|
|
4639
|
+
|
|
3624
4640
|
#### 🔌 Usage
|
|
3625
4641
|
|
|
3626
4642
|
<dl>
|
|
@@ -3727,6 +4743,23 @@ await client.organizations.get();
|
|
|
3727
4743
|
<dl>
|
|
3728
4744
|
<dd>
|
|
3729
4745
|
|
|
4746
|
+
#### 📝 Description
|
|
4747
|
+
|
|
4748
|
+
<dl>
|
|
4749
|
+
<dd>
|
|
4750
|
+
|
|
4751
|
+
<dl>
|
|
4752
|
+
<dd>
|
|
4753
|
+
|
|
4754
|
+
**CLI:**
|
|
4755
|
+
```bash
|
|
4756
|
+
agentmail pods:api-keys list --pod-id <pod_id>
|
|
4757
|
+
```
|
|
4758
|
+
</dd>
|
|
4759
|
+
</dl>
|
|
4760
|
+
</dd>
|
|
4761
|
+
</dl>
|
|
4762
|
+
|
|
3730
4763
|
#### 🔌 Usage
|
|
3731
4764
|
|
|
3732
4765
|
<dl>
|
|
@@ -3784,6 +4817,23 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
3784
4817
|
<dl>
|
|
3785
4818
|
<dd>
|
|
3786
4819
|
|
|
4820
|
+
#### 📝 Description
|
|
4821
|
+
|
|
4822
|
+
<dl>
|
|
4823
|
+
<dd>
|
|
4824
|
+
|
|
4825
|
+
<dl>
|
|
4826
|
+
<dd>
|
|
4827
|
+
|
|
4828
|
+
**CLI:**
|
|
4829
|
+
```bash
|
|
4830
|
+
agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"
|
|
4831
|
+
```
|
|
4832
|
+
</dd>
|
|
4833
|
+
</dl>
|
|
4834
|
+
</dd>
|
|
4835
|
+
</dl>
|
|
4836
|
+
|
|
3787
4837
|
#### 🔌 Usage
|
|
3788
4838
|
|
|
3789
4839
|
<dl>
|
|
@@ -3793,9 +4843,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
3793
4843
|
<dd>
|
|
3794
4844
|
|
|
3795
4845
|
```typescript
|
|
3796
|
-
await client.pods.apiKeys.create("pod_id", {
|
|
3797
|
-
name: "name"
|
|
3798
|
-
});
|
|
4846
|
+
await client.pods.apiKeys.create("pod_id", {});
|
|
3799
4847
|
|
|
3800
4848
|
```
|
|
3801
4849
|
</dd>
|
|
@@ -3843,6 +4891,23 @@ await client.pods.apiKeys.create("pod_id", {
|
|
|
3843
4891
|
<dl>
|
|
3844
4892
|
<dd>
|
|
3845
4893
|
|
|
4894
|
+
#### 📝 Description
|
|
4895
|
+
|
|
4896
|
+
<dl>
|
|
4897
|
+
<dd>
|
|
4898
|
+
|
|
4899
|
+
<dl>
|
|
4900
|
+
<dd>
|
|
4901
|
+
|
|
4902
|
+
**CLI:**
|
|
4903
|
+
```bash
|
|
4904
|
+
agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
4905
|
+
```
|
|
4906
|
+
</dd>
|
|
4907
|
+
</dl>
|
|
4908
|
+
</dd>
|
|
4909
|
+
</dl>
|
|
4910
|
+
|
|
3846
4911
|
#### 🔌 Usage
|
|
3847
4912
|
|
|
3848
4913
|
<dl>
|
|
@@ -3901,6 +4966,23 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
3901
4966
|
<dl>
|
|
3902
4967
|
<dd>
|
|
3903
4968
|
|
|
4969
|
+
#### 📝 Description
|
|
4970
|
+
|
|
4971
|
+
<dl>
|
|
4972
|
+
<dd>
|
|
4973
|
+
|
|
4974
|
+
<dl>
|
|
4975
|
+
<dd>
|
|
4976
|
+
|
|
4977
|
+
**CLI:**
|
|
4978
|
+
```bash
|
|
4979
|
+
agentmail pods:domains list --pod-id <pod_id>
|
|
4980
|
+
```
|
|
4981
|
+
</dd>
|
|
4982
|
+
</dl>
|
|
4983
|
+
</dd>
|
|
4984
|
+
</dl>
|
|
4985
|
+
|
|
3904
4986
|
#### 🔌 Usage
|
|
3905
4987
|
|
|
3906
4988
|
<dl>
|
|
@@ -3958,6 +5040,23 @@ await client.pods.domains.list("pod_id");
|
|
|
3958
5040
|
<dl>
|
|
3959
5041
|
<dd>
|
|
3960
5042
|
|
|
5043
|
+
#### 📝 Description
|
|
5044
|
+
|
|
5045
|
+
<dl>
|
|
5046
|
+
<dd>
|
|
5047
|
+
|
|
5048
|
+
<dl>
|
|
5049
|
+
<dd>
|
|
5050
|
+
|
|
5051
|
+
**CLI:**
|
|
5052
|
+
```bash
|
|
5053
|
+
agentmail pods:domains retrieve --pod-id <pod_id> --domain-id <domain_id>
|
|
5054
|
+
```
|
|
5055
|
+
</dd>
|
|
5056
|
+
</dl>
|
|
5057
|
+
</dd>
|
|
5058
|
+
</dl>
|
|
5059
|
+
|
|
3961
5060
|
#### 🔌 Usage
|
|
3962
5061
|
|
|
3963
5062
|
<dl>
|
|
@@ -4015,6 +5114,23 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
4015
5114
|
<dl>
|
|
4016
5115
|
<dd>
|
|
4017
5116
|
|
|
5117
|
+
#### 📝 Description
|
|
5118
|
+
|
|
5119
|
+
<dl>
|
|
5120
|
+
<dd>
|
|
5121
|
+
|
|
5122
|
+
<dl>
|
|
5123
|
+
<dd>
|
|
5124
|
+
|
|
5125
|
+
**CLI:**
|
|
5126
|
+
```bash
|
|
5127
|
+
agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
5128
|
+
```
|
|
5129
|
+
</dd>
|
|
5130
|
+
</dl>
|
|
5131
|
+
</dd>
|
|
5132
|
+
</dl>
|
|
5133
|
+
|
|
4018
5134
|
#### 🔌 Usage
|
|
4019
5135
|
|
|
4020
5136
|
<dl>
|
|
@@ -4072,6 +5188,23 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
4072
5188
|
<dl>
|
|
4073
5189
|
<dd>
|
|
4074
5190
|
|
|
5191
|
+
#### 📝 Description
|
|
5192
|
+
|
|
5193
|
+
<dl>
|
|
5194
|
+
<dd>
|
|
5195
|
+
|
|
5196
|
+
<dl>
|
|
5197
|
+
<dd>
|
|
5198
|
+
|
|
5199
|
+
**CLI:**
|
|
5200
|
+
```bash
|
|
5201
|
+
agentmail pods:domains create --pod-id <pod_id> --domain example.com
|
|
5202
|
+
```
|
|
5203
|
+
</dd>
|
|
5204
|
+
</dl>
|
|
5205
|
+
</dd>
|
|
5206
|
+
</dl>
|
|
5207
|
+
|
|
4075
5208
|
#### 🔌 Usage
|
|
4076
5209
|
|
|
4077
5210
|
<dl>
|
|
@@ -4132,6 +5265,23 @@ await client.pods.domains.create("pod_id", {
|
|
|
4132
5265
|
<dl>
|
|
4133
5266
|
<dd>
|
|
4134
5267
|
|
|
5268
|
+
#### 📝 Description
|
|
5269
|
+
|
|
5270
|
+
<dl>
|
|
5271
|
+
<dd>
|
|
5272
|
+
|
|
5273
|
+
<dl>
|
|
5274
|
+
<dd>
|
|
5275
|
+
|
|
5276
|
+
**CLI:**
|
|
5277
|
+
```bash
|
|
5278
|
+
agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
5279
|
+
```
|
|
5280
|
+
</dd>
|
|
5281
|
+
</dl>
|
|
5282
|
+
</dd>
|
|
5283
|
+
</dl>
|
|
5284
|
+
|
|
4135
5285
|
#### 🔌 Usage
|
|
4136
5286
|
|
|
4137
5287
|
<dl>
|
|
@@ -4197,6 +5347,23 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
4197
5347
|
<dl>
|
|
4198
5348
|
<dd>
|
|
4199
5349
|
|
|
5350
|
+
#### 📝 Description
|
|
5351
|
+
|
|
5352
|
+
<dl>
|
|
5353
|
+
<dd>
|
|
5354
|
+
|
|
5355
|
+
<dl>
|
|
5356
|
+
<dd>
|
|
5357
|
+
|
|
5358
|
+
**CLI:**
|
|
5359
|
+
```bash
|
|
5360
|
+
agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
5361
|
+
```
|
|
5362
|
+
</dd>
|
|
5363
|
+
</dl>
|
|
5364
|
+
</dd>
|
|
5365
|
+
</dl>
|
|
5366
|
+
|
|
4200
5367
|
#### 🔌 Usage
|
|
4201
5368
|
|
|
4202
5369
|
<dl>
|
|
@@ -4254,6 +5421,23 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
4254
5421
|
<dl>
|
|
4255
5422
|
<dd>
|
|
4256
5423
|
|
|
5424
|
+
#### 📝 Description
|
|
5425
|
+
|
|
5426
|
+
<dl>
|
|
5427
|
+
<dd>
|
|
5428
|
+
|
|
5429
|
+
<dl>
|
|
5430
|
+
<dd>
|
|
5431
|
+
|
|
5432
|
+
**CLI:**
|
|
5433
|
+
```bash
|
|
5434
|
+
agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
5435
|
+
```
|
|
5436
|
+
</dd>
|
|
5437
|
+
</dl>
|
|
5438
|
+
</dd>
|
|
5439
|
+
</dl>
|
|
5440
|
+
|
|
4257
5441
|
#### 🔌 Usage
|
|
4258
5442
|
|
|
4259
5443
|
<dl>
|
|
@@ -4312,6 +5496,23 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
4312
5496
|
<dl>
|
|
4313
5497
|
<dd>
|
|
4314
5498
|
|
|
5499
|
+
#### 📝 Description
|
|
5500
|
+
|
|
5501
|
+
<dl>
|
|
5502
|
+
<dd>
|
|
5503
|
+
|
|
5504
|
+
<dl>
|
|
5505
|
+
<dd>
|
|
5506
|
+
|
|
5507
|
+
**CLI:**
|
|
5508
|
+
```bash
|
|
5509
|
+
agentmail pods:drafts list --pod-id <pod_id>
|
|
5510
|
+
```
|
|
5511
|
+
</dd>
|
|
5512
|
+
</dl>
|
|
5513
|
+
</dd>
|
|
5514
|
+
</dl>
|
|
5515
|
+
|
|
4315
5516
|
#### 🔌 Usage
|
|
4316
5517
|
|
|
4317
5518
|
<dl>
|
|
@@ -4369,6 +5570,23 @@ await client.pods.drafts.list("pod_id");
|
|
|
4369
5570
|
<dl>
|
|
4370
5571
|
<dd>
|
|
4371
5572
|
|
|
5573
|
+
#### 📝 Description
|
|
5574
|
+
|
|
5575
|
+
<dl>
|
|
5576
|
+
<dd>
|
|
5577
|
+
|
|
5578
|
+
<dl>
|
|
5579
|
+
<dd>
|
|
5580
|
+
|
|
5581
|
+
**CLI:**
|
|
5582
|
+
```bash
|
|
5583
|
+
agentmail pods:drafts retrieve --pod-id <pod_id> --draft-id <draft_id>
|
|
5584
|
+
```
|
|
5585
|
+
</dd>
|
|
5586
|
+
</dl>
|
|
5587
|
+
</dd>
|
|
5588
|
+
</dl>
|
|
5589
|
+
|
|
4372
5590
|
#### 🔌 Usage
|
|
4373
5591
|
|
|
4374
5592
|
<dl>
|
|
@@ -4426,6 +5644,23 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
4426
5644
|
<dl>
|
|
4427
5645
|
<dd>
|
|
4428
5646
|
|
|
5647
|
+
#### 📝 Description
|
|
5648
|
+
|
|
5649
|
+
<dl>
|
|
5650
|
+
<dd>
|
|
5651
|
+
|
|
5652
|
+
<dl>
|
|
5653
|
+
<dd>
|
|
5654
|
+
|
|
5655
|
+
**CLI:**
|
|
5656
|
+
```bash
|
|
5657
|
+
agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
|
|
5658
|
+
```
|
|
5659
|
+
</dd>
|
|
5660
|
+
</dl>
|
|
5661
|
+
</dd>
|
|
5662
|
+
</dl>
|
|
5663
|
+
|
|
4429
5664
|
#### 🔌 Usage
|
|
4430
5665
|
|
|
4431
5666
|
<dl>
|
|
@@ -4492,6 +5727,23 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
4492
5727
|
<dl>
|
|
4493
5728
|
<dd>
|
|
4494
5729
|
|
|
5730
|
+
#### 📝 Description
|
|
5731
|
+
|
|
5732
|
+
<dl>
|
|
5733
|
+
<dd>
|
|
5734
|
+
|
|
5735
|
+
<dl>
|
|
5736
|
+
<dd>
|
|
5737
|
+
|
|
5738
|
+
**CLI:**
|
|
5739
|
+
```bash
|
|
5740
|
+
agentmail pods:inboxes list --pod-id <pod_id>
|
|
5741
|
+
```
|
|
5742
|
+
</dd>
|
|
5743
|
+
</dl>
|
|
5744
|
+
</dd>
|
|
5745
|
+
</dl>
|
|
5746
|
+
|
|
4495
5747
|
#### 🔌 Usage
|
|
4496
5748
|
|
|
4497
5749
|
<dl>
|
|
@@ -4549,6 +5801,23 @@ await client.pods.inboxes.list("pod_id");
|
|
|
4549
5801
|
<dl>
|
|
4550
5802
|
<dd>
|
|
4551
5803
|
|
|
5804
|
+
#### 📝 Description
|
|
5805
|
+
|
|
5806
|
+
<dl>
|
|
5807
|
+
<dd>
|
|
5808
|
+
|
|
5809
|
+
<dl>
|
|
5810
|
+
<dd>
|
|
5811
|
+
|
|
5812
|
+
**CLI:**
|
|
5813
|
+
```bash
|
|
5814
|
+
agentmail pods:inboxes retrieve --pod-id <pod_id> --inbox-id <inbox_id>
|
|
5815
|
+
```
|
|
5816
|
+
</dd>
|
|
5817
|
+
</dl>
|
|
5818
|
+
</dd>
|
|
5819
|
+
</dl>
|
|
5820
|
+
|
|
4552
5821
|
#### 🔌 Usage
|
|
4553
5822
|
|
|
4554
5823
|
<dl>
|
|
@@ -4606,6 +5875,23 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
4606
5875
|
<dl>
|
|
4607
5876
|
<dd>
|
|
4608
5877
|
|
|
5878
|
+
#### 📝 Description
|
|
5879
|
+
|
|
5880
|
+
<dl>
|
|
5881
|
+
<dd>
|
|
5882
|
+
|
|
5883
|
+
<dl>
|
|
5884
|
+
<dd>
|
|
5885
|
+
|
|
5886
|
+
**CLI:**
|
|
5887
|
+
```bash
|
|
5888
|
+
agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com
|
|
5889
|
+
```
|
|
5890
|
+
</dd>
|
|
5891
|
+
</dl>
|
|
5892
|
+
</dd>
|
|
5893
|
+
</dl>
|
|
5894
|
+
|
|
4609
5895
|
#### 🔌 Usage
|
|
4610
5896
|
|
|
4611
5897
|
<dl>
|
|
@@ -4663,6 +5949,23 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
4663
5949
|
<dl>
|
|
4664
5950
|
<dd>
|
|
4665
5951
|
|
|
5952
|
+
#### 📝 Description
|
|
5953
|
+
|
|
5954
|
+
<dl>
|
|
5955
|
+
<dd>
|
|
5956
|
+
|
|
5957
|
+
<dl>
|
|
5958
|
+
<dd>
|
|
5959
|
+
|
|
5960
|
+
**CLI:**
|
|
5961
|
+
```bash
|
|
5962
|
+
agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
5963
|
+
```
|
|
5964
|
+
</dd>
|
|
5965
|
+
</dl>
|
|
5966
|
+
</dd>
|
|
5967
|
+
</dl>
|
|
5968
|
+
|
|
4666
5969
|
#### 🔌 Usage
|
|
4667
5970
|
|
|
4668
5971
|
<dl>
|
|
@@ -4730,6 +6033,23 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {
|
|
|
4730
6033
|
<dl>
|
|
4731
6034
|
<dd>
|
|
4732
6035
|
|
|
6036
|
+
#### 📝 Description
|
|
6037
|
+
|
|
6038
|
+
<dl>
|
|
6039
|
+
<dd>
|
|
6040
|
+
|
|
6041
|
+
<dl>
|
|
6042
|
+
<dd>
|
|
6043
|
+
|
|
6044
|
+
**CLI:**
|
|
6045
|
+
```bash
|
|
6046
|
+
agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
6047
|
+
```
|
|
6048
|
+
</dd>
|
|
6049
|
+
</dl>
|
|
6050
|
+
</dd>
|
|
6051
|
+
</dl>
|
|
6052
|
+
|
|
4733
6053
|
#### 🔌 Usage
|
|
4734
6054
|
|
|
4735
6055
|
<dl>
|
|
@@ -4788,6 +6108,23 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
4788
6108
|
<dl>
|
|
4789
6109
|
<dd>
|
|
4790
6110
|
|
|
6111
|
+
#### 📝 Description
|
|
6112
|
+
|
|
6113
|
+
<dl>
|
|
6114
|
+
<dd>
|
|
6115
|
+
|
|
6116
|
+
<dl>
|
|
6117
|
+
<dd>
|
|
6118
|
+
|
|
6119
|
+
**CLI:**
|
|
6120
|
+
```bash
|
|
6121
|
+
agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type>
|
|
6122
|
+
```
|
|
6123
|
+
</dd>
|
|
6124
|
+
</dl>
|
|
6125
|
+
</dd>
|
|
6126
|
+
</dl>
|
|
6127
|
+
|
|
4791
6128
|
#### 🔌 Usage
|
|
4792
6129
|
|
|
4793
6130
|
<dl>
|
|
@@ -4861,6 +6198,23 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
4861
6198
|
<dl>
|
|
4862
6199
|
<dd>
|
|
4863
6200
|
|
|
6201
|
+
#### 📝 Description
|
|
6202
|
+
|
|
6203
|
+
<dl>
|
|
6204
|
+
<dd>
|
|
6205
|
+
|
|
6206
|
+
<dl>
|
|
6207
|
+
<dd>
|
|
6208
|
+
|
|
6209
|
+
**CLI:**
|
|
6210
|
+
```bash
|
|
6211
|
+
agentmail pods:lists retrieve --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
6212
|
+
```
|
|
6213
|
+
</dd>
|
|
6214
|
+
</dl>
|
|
6215
|
+
</dd>
|
|
6216
|
+
</dl>
|
|
6217
|
+
|
|
4864
6218
|
#### 🔌 Usage
|
|
4865
6219
|
|
|
4866
6220
|
<dl>
|
|
@@ -4934,6 +6288,23 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
4934
6288
|
<dl>
|
|
4935
6289
|
<dd>
|
|
4936
6290
|
|
|
6291
|
+
#### 📝 Description
|
|
6292
|
+
|
|
6293
|
+
<dl>
|
|
6294
|
+
<dd>
|
|
6295
|
+
|
|
6296
|
+
<dl>
|
|
6297
|
+
<dd>
|
|
6298
|
+
|
|
6299
|
+
**CLI:**
|
|
6300
|
+
```bash
|
|
6301
|
+
agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com
|
|
6302
|
+
```
|
|
6303
|
+
</dd>
|
|
6304
|
+
</dl>
|
|
6305
|
+
</dd>
|
|
6306
|
+
</dl>
|
|
6307
|
+
|
|
4937
6308
|
#### 🔌 Usage
|
|
4938
6309
|
|
|
4939
6310
|
<dl>
|
|
@@ -5009,6 +6380,23 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
5009
6380
|
<dl>
|
|
5010
6381
|
<dd>
|
|
5011
6382
|
|
|
6383
|
+
#### 📝 Description
|
|
6384
|
+
|
|
6385
|
+
<dl>
|
|
6386
|
+
<dd>
|
|
6387
|
+
|
|
6388
|
+
<dl>
|
|
6389
|
+
<dd>
|
|
6390
|
+
|
|
6391
|
+
**CLI:**
|
|
6392
|
+
```bash
|
|
6393
|
+
agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
6394
|
+
```
|
|
6395
|
+
</dd>
|
|
6396
|
+
</dl>
|
|
6397
|
+
</dd>
|
|
6398
|
+
</dl>
|
|
6399
|
+
|
|
5012
6400
|
#### 🔌 Usage
|
|
5013
6401
|
|
|
5014
6402
|
<dl>
|
|
@@ -5083,6 +6471,23 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
5083
6471
|
<dl>
|
|
5084
6472
|
<dd>
|
|
5085
6473
|
|
|
6474
|
+
#### 📝 Description
|
|
6475
|
+
|
|
6476
|
+
<dl>
|
|
6477
|
+
<dd>
|
|
6478
|
+
|
|
6479
|
+
<dl>
|
|
6480
|
+
<dd>
|
|
6481
|
+
|
|
6482
|
+
**CLI:**
|
|
6483
|
+
```bash
|
|
6484
|
+
agentmail pods:metrics query --pod-id <pod_id>
|
|
6485
|
+
```
|
|
6486
|
+
</dd>
|
|
6487
|
+
</dl>
|
|
6488
|
+
</dd>
|
|
6489
|
+
</dl>
|
|
6490
|
+
|
|
5086
6491
|
#### 🔌 Usage
|
|
5087
6492
|
|
|
5088
6493
|
<dl>
|
|
@@ -5141,6 +6546,23 @@ await client.pods.metrics.query("pod_id");
|
|
|
5141
6546
|
<dl>
|
|
5142
6547
|
<dd>
|
|
5143
6548
|
|
|
6549
|
+
#### 📝 Description
|
|
6550
|
+
|
|
6551
|
+
<dl>
|
|
6552
|
+
<dd>
|
|
6553
|
+
|
|
6554
|
+
<dl>
|
|
6555
|
+
<dd>
|
|
6556
|
+
|
|
6557
|
+
**CLI:**
|
|
6558
|
+
```bash
|
|
6559
|
+
agentmail pods:threads list --pod-id <pod_id>
|
|
6560
|
+
```
|
|
6561
|
+
</dd>
|
|
6562
|
+
</dl>
|
|
6563
|
+
</dd>
|
|
6564
|
+
</dl>
|
|
6565
|
+
|
|
5144
6566
|
#### 🔌 Usage
|
|
5145
6567
|
|
|
5146
6568
|
<dl>
|
|
@@ -5198,6 +6620,23 @@ await client.pods.threads.list("pod_id");
|
|
|
5198
6620
|
<dl>
|
|
5199
6621
|
<dd>
|
|
5200
6622
|
|
|
6623
|
+
#### 📝 Description
|
|
6624
|
+
|
|
6625
|
+
<dl>
|
|
6626
|
+
<dd>
|
|
6627
|
+
|
|
6628
|
+
<dl>
|
|
6629
|
+
<dd>
|
|
6630
|
+
|
|
6631
|
+
**CLI:**
|
|
6632
|
+
```bash
|
|
6633
|
+
agentmail pods:threads retrieve --pod-id <pod_id> --thread-id <thread_id>
|
|
6634
|
+
```
|
|
6635
|
+
</dd>
|
|
6636
|
+
</dl>
|
|
6637
|
+
</dd>
|
|
6638
|
+
</dl>
|
|
6639
|
+
|
|
5201
6640
|
#### 🔌 Usage
|
|
5202
6641
|
|
|
5203
6642
|
<dl>
|
|
@@ -5255,6 +6694,23 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
5255
6694
|
<dl>
|
|
5256
6695
|
<dd>
|
|
5257
6696
|
|
|
6697
|
+
#### 📝 Description
|
|
6698
|
+
|
|
6699
|
+
<dl>
|
|
6700
|
+
<dd>
|
|
6701
|
+
|
|
6702
|
+
<dl>
|
|
6703
|
+
<dd>
|
|
6704
|
+
|
|
6705
|
+
**CLI:**
|
|
6706
|
+
```bash
|
|
6707
|
+
agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
6708
|
+
```
|
|
6709
|
+
</dd>
|
|
6710
|
+
</dl>
|
|
6711
|
+
</dd>
|
|
6712
|
+
</dl>
|
|
6713
|
+
|
|
5258
6714
|
#### 🔌 Usage
|
|
5259
6715
|
|
|
5260
6716
|
<dl>
|
|
@@ -5408,6 +6864,11 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
5408
6864
|
<dd>
|
|
5409
6865
|
|
|
5410
6866
|
Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
6867
|
+
|
|
6868
|
+
**CLI:**
|
|
6869
|
+
```bash
|
|
6870
|
+
agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
6871
|
+
```
|
|
5411
6872
|
</dd>
|
|
5412
6873
|
</dl>
|
|
5413
6874
|
</dd>
|
|
@@ -5479,6 +6940,23 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
5479
6940
|
<dl>
|
|
5480
6941
|
<dd>
|
|
5481
6942
|
|
|
6943
|
+
#### 📝 Description
|
|
6944
|
+
|
|
6945
|
+
<dl>
|
|
6946
|
+
<dd>
|
|
6947
|
+
|
|
6948
|
+
<dl>
|
|
6949
|
+
<dd>
|
|
6950
|
+
|
|
6951
|
+
**CLI:**
|
|
6952
|
+
```bash
|
|
6953
|
+
agentmail threads list
|
|
6954
|
+
```
|
|
6955
|
+
</dd>
|
|
6956
|
+
</dl>
|
|
6957
|
+
</dd>
|
|
6958
|
+
</dl>
|
|
6959
|
+
|
|
5482
6960
|
#### 🔌 Usage
|
|
5483
6961
|
|
|
5484
6962
|
<dl>
|
|
@@ -5528,6 +7006,23 @@ await client.threads.list();
|
|
|
5528
7006
|
<dl>
|
|
5529
7007
|
<dd>
|
|
5530
7008
|
|
|
7009
|
+
#### 📝 Description
|
|
7010
|
+
|
|
7011
|
+
<dl>
|
|
7012
|
+
<dd>
|
|
7013
|
+
|
|
7014
|
+
<dl>
|
|
7015
|
+
<dd>
|
|
7016
|
+
|
|
7017
|
+
**CLI:**
|
|
7018
|
+
```bash
|
|
7019
|
+
agentmail threads retrieve --thread-id <thread_id>
|
|
7020
|
+
```
|
|
7021
|
+
</dd>
|
|
7022
|
+
</dl>
|
|
7023
|
+
</dd>
|
|
7024
|
+
</dl>
|
|
7025
|
+
|
|
5531
7026
|
#### 🔌 Usage
|
|
5532
7027
|
|
|
5533
7028
|
<dl>
|
|
@@ -5577,6 +7072,23 @@ await client.threads.get("thread_id");
|
|
|
5577
7072
|
<dl>
|
|
5578
7073
|
<dd>
|
|
5579
7074
|
|
|
7075
|
+
#### 📝 Description
|
|
7076
|
+
|
|
7077
|
+
<dl>
|
|
7078
|
+
<dd>
|
|
7079
|
+
|
|
7080
|
+
<dl>
|
|
7081
|
+
<dd>
|
|
7082
|
+
|
|
7083
|
+
**CLI:**
|
|
7084
|
+
```bash
|
|
7085
|
+
agentmail threads retrieve-attachment --thread-id <thread_id> --attachment-id <attachment_id>
|
|
7086
|
+
```
|
|
7087
|
+
</dd>
|
|
7088
|
+
</dl>
|
|
7089
|
+
</dd>
|
|
7090
|
+
</dl>
|
|
7091
|
+
|
|
5580
7092
|
#### 🔌 Usage
|
|
5581
7093
|
|
|
5582
7094
|
<dl>
|
|
@@ -5714,6 +7226,11 @@ await client.threads.update("thread_id", {});
|
|
|
5714
7226
|
<dd>
|
|
5715
7227
|
|
|
5716
7228
|
Moves the thread to trash by adding a trash label to all messages. If the thread is already in trash, it will be permanently deleted. Use `permanent=true` to force permanent deletion.
|
|
7229
|
+
|
|
7230
|
+
**CLI:**
|
|
7231
|
+
```bash
|
|
7232
|
+
agentmail threads delete --thread-id <thread_id>
|
|
7233
|
+
```
|
|
5717
7234
|
</dd>
|
|
5718
7235
|
</dl>
|
|
5719
7236
|
</dd>
|