agentmail 0.4.15 → 0.4.17
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 +64 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +106 -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 +64 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +106 -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 +1620 -27
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,7 +1303,7 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1004
1303
|
<dl>
|
|
1005
1304
|
<dd>
|
|
1006
1305
|
|
|
1007
|
-
####
|
|
1306
|
+
#### 📝 Description
|
|
1008
1307
|
|
|
1009
1308
|
<dl>
|
|
1010
1309
|
<dd>
|
|
@@ -1012,16 +1311,16 @@ await client.apiKeys.delete("api_key_id");
|
|
|
1012
1311
|
<dl>
|
|
1013
1312
|
<dd>
|
|
1014
1313
|
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
|
|
1314
|
+
**CLI:**
|
|
1315
|
+
```bash
|
|
1316
|
+
agentmail domains list
|
|
1018
1317
|
```
|
|
1019
1318
|
</dd>
|
|
1020
1319
|
</dl>
|
|
1021
1320
|
</dd>
|
|
1022
1321
|
</dl>
|
|
1023
1322
|
|
|
1024
|
-
####
|
|
1323
|
+
#### 🔌 Usage
|
|
1025
1324
|
|
|
1026
1325
|
<dl>
|
|
1027
1326
|
<dd>
|
|
@@ -1029,11 +1328,28 @@ await client.domains.list();
|
|
|
1029
1328
|
<dl>
|
|
1030
1329
|
<dd>
|
|
1031
1330
|
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1331
|
+
```typescript
|
|
1332
|
+
await client.domains.list();
|
|
1333
|
+
|
|
1334
|
+
```
|
|
1335
|
+
</dd>
|
|
1336
|
+
</dl>
|
|
1337
|
+
</dd>
|
|
1338
|
+
</dl>
|
|
1339
|
+
|
|
1340
|
+
#### ⚙️ Parameters
|
|
1341
|
+
|
|
1342
|
+
<dl>
|
|
1343
|
+
<dd>
|
|
1344
|
+
|
|
1345
|
+
<dl>
|
|
1346
|
+
<dd>
|
|
1347
|
+
|
|
1348
|
+
**request:** `AgentMail.ListDomainsRequest`
|
|
1349
|
+
|
|
1350
|
+
</dd>
|
|
1351
|
+
</dl>
|
|
1352
|
+
|
|
1037
1353
|
<dl>
|
|
1038
1354
|
<dd>
|
|
1039
1355
|
|
|
@@ -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>
|
|
@@ -1868,6 +2437,23 @@ await client.inboxes.drafts.getAttachment("inbox_id", "draft_id", "attachment_id
|
|
|
1868
2437
|
<dl>
|
|
1869
2438
|
<dd>
|
|
1870
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>
|
|
2456
|
+
|
|
1871
2457
|
#### 🔌 Usage
|
|
1872
2458
|
|
|
1873
2459
|
<dl>
|
|
@@ -1925,7 +2511,7 @@ await client.inboxes.drafts.create("inbox_id", {});
|
|
|
1925
2511
|
<dl>
|
|
1926
2512
|
<dd>
|
|
1927
2513
|
|
|
1928
|
-
####
|
|
2514
|
+
#### 📝 Description
|
|
1929
2515
|
|
|
1930
2516
|
<dl>
|
|
1931
2517
|
<dd>
|
|
@@ -1933,16 +2519,16 @@ await client.inboxes.drafts.create("inbox_id", {});
|
|
|
1933
2519
|
<dl>
|
|
1934
2520
|
<dd>
|
|
1935
2521
|
|
|
1936
|
-
|
|
1937
|
-
|
|
1938
|
-
|
|
2522
|
+
**CLI:**
|
|
2523
|
+
```bash
|
|
2524
|
+
agentmail inboxes:drafts update --inbox-id <inbox_id> --draft-id <draft_id> --subject "Updated subject"
|
|
1939
2525
|
```
|
|
1940
2526
|
</dd>
|
|
1941
2527
|
</dl>
|
|
1942
2528
|
</dd>
|
|
1943
2529
|
</dl>
|
|
1944
2530
|
|
|
1945
|
-
####
|
|
2531
|
+
#### 🔌 Usage
|
|
1946
2532
|
|
|
1947
2533
|
<dl>
|
|
1948
2534
|
<dd>
|
|
@@ -1950,8 +2536,25 @@ await client.inboxes.drafts.update("inbox_id", "draft_id", {});
|
|
|
1950
2536
|
<dl>
|
|
1951
2537
|
<dd>
|
|
1952
2538
|
|
|
1953
|
-
|
|
1954
|
-
|
|
2539
|
+
```typescript
|
|
2540
|
+
await client.inboxes.drafts.update("inbox_id", "draft_id", {});
|
|
2541
|
+
|
|
2542
|
+
```
|
|
2543
|
+
</dd>
|
|
2544
|
+
</dl>
|
|
2545
|
+
</dd>
|
|
2546
|
+
</dl>
|
|
2547
|
+
|
|
2548
|
+
#### ⚙️ Parameters
|
|
2549
|
+
|
|
2550
|
+
<dl>
|
|
2551
|
+
<dd>
|
|
2552
|
+
|
|
2553
|
+
<dl>
|
|
2554
|
+
<dd>
|
|
2555
|
+
|
|
2556
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2557
|
+
|
|
1955
2558
|
</dd>
|
|
1956
2559
|
</dl>
|
|
1957
2560
|
|
|
@@ -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>
|
|
@@ -2701,6 +3491,82 @@ await client.inboxes.messages.update("inbox_id", "message_id", {});
|
|
|
2701
3491
|
</dl>
|
|
2702
3492
|
|
|
2703
3493
|
|
|
3494
|
+
</dd>
|
|
3495
|
+
</dl>
|
|
3496
|
+
</details>
|
|
3497
|
+
|
|
3498
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">delete</a>(inbox_id, message_id) -> void</code></summary>
|
|
3499
|
+
<dl>
|
|
3500
|
+
<dd>
|
|
3501
|
+
|
|
3502
|
+
#### 📝 Description
|
|
3503
|
+
|
|
3504
|
+
<dl>
|
|
3505
|
+
<dd>
|
|
3506
|
+
|
|
3507
|
+
<dl>
|
|
3508
|
+
<dd>
|
|
3509
|
+
|
|
3510
|
+
Permanently deletes a message.
|
|
3511
|
+
|
|
3512
|
+
**CLI:**
|
|
3513
|
+
```bash
|
|
3514
|
+
agentmail inboxes:messages delete --inbox-id <inbox_id> --message-id <message_id>
|
|
3515
|
+
```
|
|
3516
|
+
</dd>
|
|
3517
|
+
</dl>
|
|
3518
|
+
</dd>
|
|
3519
|
+
</dl>
|
|
3520
|
+
|
|
3521
|
+
#### 🔌 Usage
|
|
3522
|
+
|
|
3523
|
+
<dl>
|
|
3524
|
+
<dd>
|
|
3525
|
+
|
|
3526
|
+
<dl>
|
|
3527
|
+
<dd>
|
|
3528
|
+
|
|
3529
|
+
```typescript
|
|
3530
|
+
await client.inboxes.messages.delete("inbox_id", "message_id");
|
|
3531
|
+
|
|
3532
|
+
```
|
|
3533
|
+
</dd>
|
|
3534
|
+
</dl>
|
|
3535
|
+
</dd>
|
|
3536
|
+
</dl>
|
|
3537
|
+
|
|
3538
|
+
#### ⚙️ Parameters
|
|
3539
|
+
|
|
3540
|
+
<dl>
|
|
3541
|
+
<dd>
|
|
3542
|
+
|
|
3543
|
+
<dl>
|
|
3544
|
+
<dd>
|
|
3545
|
+
|
|
3546
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
3547
|
+
|
|
3548
|
+
</dd>
|
|
3549
|
+
</dl>
|
|
3550
|
+
|
|
3551
|
+
<dl>
|
|
3552
|
+
<dd>
|
|
3553
|
+
|
|
3554
|
+
**message_id:** `AgentMail.MessageId`
|
|
3555
|
+
|
|
3556
|
+
</dd>
|
|
3557
|
+
</dl>
|
|
3558
|
+
|
|
3559
|
+
<dl>
|
|
3560
|
+
<dd>
|
|
3561
|
+
|
|
3562
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
3563
|
+
|
|
3564
|
+
</dd>
|
|
3565
|
+
</dl>
|
|
3566
|
+
</dd>
|
|
3567
|
+
</dl>
|
|
3568
|
+
|
|
3569
|
+
|
|
2704
3570
|
</dd>
|
|
2705
3571
|
</dl>
|
|
2706
3572
|
</details>
|
|
@@ -2709,6 +3575,23 @@ await client.inboxes.messages.update("inbox_id", "message_id", {});
|
|
|
2709
3575
|
<dl>
|
|
2710
3576
|
<dd>
|
|
2711
3577
|
|
|
3578
|
+
#### 📝 Description
|
|
3579
|
+
|
|
3580
|
+
<dl>
|
|
3581
|
+
<dd>
|
|
3582
|
+
|
|
3583
|
+
<dl>
|
|
3584
|
+
<dd>
|
|
3585
|
+
|
|
3586
|
+
**CLI:**
|
|
3587
|
+
```bash
|
|
3588
|
+
agentmail inboxes:messages send --inbox-id <inbox_id> --to recipient@example.com --subject "Hello" --text "Body"
|
|
3589
|
+
```
|
|
3590
|
+
</dd>
|
|
3591
|
+
</dl>
|
|
3592
|
+
</dd>
|
|
3593
|
+
</dl>
|
|
3594
|
+
|
|
2712
3595
|
#### 🔌 Usage
|
|
2713
3596
|
|
|
2714
3597
|
<dl>
|
|
@@ -2766,6 +3649,23 @@ await client.inboxes.messages.send("inbox_id", {});
|
|
|
2766
3649
|
<dl>
|
|
2767
3650
|
<dd>
|
|
2768
3651
|
|
|
3652
|
+
#### 📝 Description
|
|
3653
|
+
|
|
3654
|
+
<dl>
|
|
3655
|
+
<dd>
|
|
3656
|
+
|
|
3657
|
+
<dl>
|
|
3658
|
+
<dd>
|
|
3659
|
+
|
|
3660
|
+
**CLI:**
|
|
3661
|
+
```bash
|
|
3662
|
+
agentmail inboxes:messages reply --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
3663
|
+
```
|
|
3664
|
+
</dd>
|
|
3665
|
+
</dl>
|
|
3666
|
+
</dd>
|
|
3667
|
+
</dl>
|
|
3668
|
+
|
|
2769
3669
|
#### 🔌 Usage
|
|
2770
3670
|
|
|
2771
3671
|
<dl>
|
|
@@ -2831,6 +3731,23 @@ await client.inboxes.messages.reply("inbox_id", "message_id", {});
|
|
|
2831
3731
|
<dl>
|
|
2832
3732
|
<dd>
|
|
2833
3733
|
|
|
3734
|
+
#### 📝 Description
|
|
3735
|
+
|
|
3736
|
+
<dl>
|
|
3737
|
+
<dd>
|
|
3738
|
+
|
|
3739
|
+
<dl>
|
|
3740
|
+
<dd>
|
|
3741
|
+
|
|
3742
|
+
**CLI:**
|
|
3743
|
+
```bash
|
|
3744
|
+
agentmail inboxes:messages reply-all --inbox-id <inbox_id> --message-id <message_id> --text "Reply text"
|
|
3745
|
+
```
|
|
3746
|
+
</dd>
|
|
3747
|
+
</dl>
|
|
3748
|
+
</dd>
|
|
3749
|
+
</dl>
|
|
3750
|
+
|
|
2834
3751
|
#### 🔌 Usage
|
|
2835
3752
|
|
|
2836
3753
|
<dl>
|
|
@@ -2896,6 +3813,23 @@ await client.inboxes.messages.replyAll("inbox_id", "message_id", {});
|
|
|
2896
3813
|
<dl>
|
|
2897
3814
|
<dd>
|
|
2898
3815
|
|
|
3816
|
+
#### 📝 Description
|
|
3817
|
+
|
|
3818
|
+
<dl>
|
|
3819
|
+
<dd>
|
|
3820
|
+
|
|
3821
|
+
<dl>
|
|
3822
|
+
<dd>
|
|
3823
|
+
|
|
3824
|
+
**CLI:**
|
|
3825
|
+
```bash
|
|
3826
|
+
agentmail inboxes:messages forward --inbox-id <inbox_id> --message-id <message_id> --to recipient@example.com
|
|
3827
|
+
```
|
|
3828
|
+
</dd>
|
|
3829
|
+
</dl>
|
|
3830
|
+
</dd>
|
|
3831
|
+
</dl>
|
|
3832
|
+
|
|
2899
3833
|
#### 🔌 Usage
|
|
2900
3834
|
|
|
2901
3835
|
<dl>
|
|
@@ -2962,6 +3896,23 @@ await client.inboxes.messages.forward("inbox_id", "message_id", {});
|
|
|
2962
3896
|
<dl>
|
|
2963
3897
|
<dd>
|
|
2964
3898
|
|
|
3899
|
+
#### 📝 Description
|
|
3900
|
+
|
|
3901
|
+
<dl>
|
|
3902
|
+
<dd>
|
|
3903
|
+
|
|
3904
|
+
<dl>
|
|
3905
|
+
<dd>
|
|
3906
|
+
|
|
3907
|
+
**CLI:**
|
|
3908
|
+
```bash
|
|
3909
|
+
agentmail inboxes:metrics query --inbox-id <inbox_id>
|
|
3910
|
+
```
|
|
3911
|
+
</dd>
|
|
3912
|
+
</dl>
|
|
3913
|
+
</dd>
|
|
3914
|
+
</dl>
|
|
3915
|
+
|
|
2965
3916
|
#### 🔌 Usage
|
|
2966
3917
|
|
|
2967
3918
|
<dl>
|
|
@@ -3020,6 +3971,23 @@ await client.inboxes.metrics.query("inbox_id");
|
|
|
3020
3971
|
<dl>
|
|
3021
3972
|
<dd>
|
|
3022
3973
|
|
|
3974
|
+
#### 📝 Description
|
|
3975
|
+
|
|
3976
|
+
<dl>
|
|
3977
|
+
<dd>
|
|
3978
|
+
|
|
3979
|
+
<dl>
|
|
3980
|
+
<dd>
|
|
3981
|
+
|
|
3982
|
+
**CLI:**
|
|
3983
|
+
```bash
|
|
3984
|
+
agentmail inboxes:threads list --inbox-id <inbox_id>
|
|
3985
|
+
```
|
|
3986
|
+
</dd>
|
|
3987
|
+
</dl>
|
|
3988
|
+
</dd>
|
|
3989
|
+
</dl>
|
|
3990
|
+
|
|
3023
3991
|
#### 🔌 Usage
|
|
3024
3992
|
|
|
3025
3993
|
<dl>
|
|
@@ -3077,6 +4045,23 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
3077
4045
|
<dl>
|
|
3078
4046
|
<dd>
|
|
3079
4047
|
|
|
4048
|
+
#### 📝 Description
|
|
4049
|
+
|
|
4050
|
+
<dl>
|
|
4051
|
+
<dd>
|
|
4052
|
+
|
|
4053
|
+
<dl>
|
|
4054
|
+
<dd>
|
|
4055
|
+
|
|
4056
|
+
**CLI:**
|
|
4057
|
+
```bash
|
|
4058
|
+
agentmail inboxes:threads retrieve --inbox-id <inbox_id> --thread-id <thread_id>
|
|
4059
|
+
```
|
|
4060
|
+
</dd>
|
|
4061
|
+
</dl>
|
|
4062
|
+
</dd>
|
|
4063
|
+
</dl>
|
|
4064
|
+
|
|
3080
4065
|
#### 🔌 Usage
|
|
3081
4066
|
|
|
3082
4067
|
<dl>
|
|
@@ -3134,6 +4119,23 @@ await client.inboxes.threads.get("inbox_id", "thread_id");
|
|
|
3134
4119
|
<dl>
|
|
3135
4120
|
<dd>
|
|
3136
4121
|
|
|
4122
|
+
#### 📝 Description
|
|
4123
|
+
|
|
4124
|
+
<dl>
|
|
4125
|
+
<dd>
|
|
4126
|
+
|
|
4127
|
+
<dl>
|
|
4128
|
+
<dd>
|
|
4129
|
+
|
|
4130
|
+
**CLI:**
|
|
4131
|
+
```bash
|
|
4132
|
+
agentmail inboxes:threads get-attachment --inbox-id <inbox_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
4133
|
+
```
|
|
4134
|
+
</dd>
|
|
4135
|
+
</dl>
|
|
4136
|
+
</dd>
|
|
4137
|
+
</dl>
|
|
4138
|
+
|
|
3137
4139
|
#### 🔌 Usage
|
|
3138
4140
|
|
|
3139
4141
|
<dl>
|
|
@@ -3287,6 +4289,11 @@ await client.inboxes.threads.update("inbox_id", "thread_id", {});
|
|
|
3287
4289
|
<dd>
|
|
3288
4290
|
|
|
3289
4291
|
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.
|
|
4292
|
+
|
|
4293
|
+
**CLI:**
|
|
4294
|
+
```bash
|
|
4295
|
+
agentmail inboxes:threads delete --inbox-id <inbox_id> --thread-id <thread_id>
|
|
4296
|
+
```
|
|
3290
4297
|
</dd>
|
|
3291
4298
|
</dl>
|
|
3292
4299
|
</dd>
|
|
@@ -3358,6 +4365,23 @@ await client.inboxes.threads.delete("inbox_id", "thread_id");
|
|
|
3358
4365
|
<dl>
|
|
3359
4366
|
<dd>
|
|
3360
4367
|
|
|
4368
|
+
#### 📝 Description
|
|
4369
|
+
|
|
4370
|
+
<dl>
|
|
4371
|
+
<dd>
|
|
4372
|
+
|
|
4373
|
+
<dl>
|
|
4374
|
+
<dd>
|
|
4375
|
+
|
|
4376
|
+
**CLI:**
|
|
4377
|
+
```bash
|
|
4378
|
+
agentmail lists list --direction <direction> --type <type>
|
|
4379
|
+
```
|
|
4380
|
+
</dd>
|
|
4381
|
+
</dl>
|
|
4382
|
+
</dd>
|
|
4383
|
+
</dl>
|
|
4384
|
+
|
|
3361
4385
|
#### 🔌 Usage
|
|
3362
4386
|
|
|
3363
4387
|
<dl>
|
|
@@ -3423,6 +4447,23 @@ await client.lists.list("send", "allow");
|
|
|
3423
4447
|
<dl>
|
|
3424
4448
|
<dd>
|
|
3425
4449
|
|
|
4450
|
+
#### 📝 Description
|
|
4451
|
+
|
|
4452
|
+
<dl>
|
|
4453
|
+
<dd>
|
|
4454
|
+
|
|
4455
|
+
<dl>
|
|
4456
|
+
<dd>
|
|
4457
|
+
|
|
4458
|
+
**CLI:**
|
|
4459
|
+
```bash
|
|
4460
|
+
agentmail lists retrieve --direction <direction> --type <type> --entry <entry>
|
|
4461
|
+
```
|
|
4462
|
+
</dd>
|
|
4463
|
+
</dl>
|
|
4464
|
+
</dd>
|
|
4465
|
+
</dl>
|
|
4466
|
+
|
|
3426
4467
|
#### 🔌 Usage
|
|
3427
4468
|
|
|
3428
4469
|
<dl>
|
|
@@ -3488,6 +4529,23 @@ await client.lists.get("send", "allow", "entry");
|
|
|
3488
4529
|
<dl>
|
|
3489
4530
|
<dd>
|
|
3490
4531
|
|
|
4532
|
+
#### 📝 Description
|
|
4533
|
+
|
|
4534
|
+
<dl>
|
|
4535
|
+
<dd>
|
|
4536
|
+
|
|
4537
|
+
<dl>
|
|
4538
|
+
<dd>
|
|
4539
|
+
|
|
4540
|
+
**CLI:**
|
|
4541
|
+
```bash
|
|
4542
|
+
agentmail lists create --direction <direction> --type <type> --entry user@example.com
|
|
4543
|
+
```
|
|
4544
|
+
</dd>
|
|
4545
|
+
</dl>
|
|
4546
|
+
</dd>
|
|
4547
|
+
</dl>
|
|
4548
|
+
|
|
3491
4549
|
#### 🔌 Usage
|
|
3492
4550
|
|
|
3493
4551
|
<dl>
|
|
@@ -3555,6 +4613,23 @@ await client.lists.create("send", "allow", {
|
|
|
3555
4613
|
<dl>
|
|
3556
4614
|
<dd>
|
|
3557
4615
|
|
|
4616
|
+
#### 📝 Description
|
|
4617
|
+
|
|
4618
|
+
<dl>
|
|
4619
|
+
<dd>
|
|
4620
|
+
|
|
4621
|
+
<dl>
|
|
4622
|
+
<dd>
|
|
4623
|
+
|
|
4624
|
+
**CLI:**
|
|
4625
|
+
```bash
|
|
4626
|
+
agentmail lists delete --direction <direction> --type <type> --entry <entry>
|
|
4627
|
+
```
|
|
4628
|
+
</dd>
|
|
4629
|
+
</dl>
|
|
4630
|
+
</dd>
|
|
4631
|
+
</dl>
|
|
4632
|
+
|
|
3558
4633
|
#### 🔌 Usage
|
|
3559
4634
|
|
|
3560
4635
|
<dl>
|
|
@@ -3621,6 +4696,23 @@ await client.lists.delete("send", "allow", "entry");
|
|
|
3621
4696
|
<dl>
|
|
3622
4697
|
<dd>
|
|
3623
4698
|
|
|
4699
|
+
#### 📝 Description
|
|
4700
|
+
|
|
4701
|
+
<dl>
|
|
4702
|
+
<dd>
|
|
4703
|
+
|
|
4704
|
+
<dl>
|
|
4705
|
+
<dd>
|
|
4706
|
+
|
|
4707
|
+
**CLI:**
|
|
4708
|
+
```bash
|
|
4709
|
+
agentmail metrics list
|
|
4710
|
+
```
|
|
4711
|
+
</dd>
|
|
4712
|
+
</dl>
|
|
4713
|
+
</dd>
|
|
4714
|
+
</dl>
|
|
4715
|
+
|
|
3624
4716
|
#### 🔌 Usage
|
|
3625
4717
|
|
|
3626
4718
|
<dl>
|
|
@@ -3727,6 +4819,23 @@ await client.organizations.get();
|
|
|
3727
4819
|
<dl>
|
|
3728
4820
|
<dd>
|
|
3729
4821
|
|
|
4822
|
+
#### 📝 Description
|
|
4823
|
+
|
|
4824
|
+
<dl>
|
|
4825
|
+
<dd>
|
|
4826
|
+
|
|
4827
|
+
<dl>
|
|
4828
|
+
<dd>
|
|
4829
|
+
|
|
4830
|
+
**CLI:**
|
|
4831
|
+
```bash
|
|
4832
|
+
agentmail pods:api-keys list --pod-id <pod_id>
|
|
4833
|
+
```
|
|
4834
|
+
</dd>
|
|
4835
|
+
</dl>
|
|
4836
|
+
</dd>
|
|
4837
|
+
</dl>
|
|
4838
|
+
|
|
3730
4839
|
#### 🔌 Usage
|
|
3731
4840
|
|
|
3732
4841
|
<dl>
|
|
@@ -3784,6 +4893,23 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
3784
4893
|
<dl>
|
|
3785
4894
|
<dd>
|
|
3786
4895
|
|
|
4896
|
+
#### 📝 Description
|
|
4897
|
+
|
|
4898
|
+
<dl>
|
|
4899
|
+
<dd>
|
|
4900
|
+
|
|
4901
|
+
<dl>
|
|
4902
|
+
<dd>
|
|
4903
|
+
|
|
4904
|
+
**CLI:**
|
|
4905
|
+
```bash
|
|
4906
|
+
agentmail pods:api-keys create --pod-id <pod_id> --name "My Key"
|
|
4907
|
+
```
|
|
4908
|
+
</dd>
|
|
4909
|
+
</dl>
|
|
4910
|
+
</dd>
|
|
4911
|
+
</dl>
|
|
4912
|
+
|
|
3787
4913
|
#### 🔌 Usage
|
|
3788
4914
|
|
|
3789
4915
|
<dl>
|
|
@@ -3793,9 +4919,7 @@ await client.pods.apiKeys.list("pod_id");
|
|
|
3793
4919
|
<dd>
|
|
3794
4920
|
|
|
3795
4921
|
```typescript
|
|
3796
|
-
await client.pods.apiKeys.create("pod_id", {
|
|
3797
|
-
name: "name"
|
|
3798
|
-
});
|
|
4922
|
+
await client.pods.apiKeys.create("pod_id", {});
|
|
3799
4923
|
|
|
3800
4924
|
```
|
|
3801
4925
|
</dd>
|
|
@@ -3843,6 +4967,23 @@ await client.pods.apiKeys.create("pod_id", {
|
|
|
3843
4967
|
<dl>
|
|
3844
4968
|
<dd>
|
|
3845
4969
|
|
|
4970
|
+
#### 📝 Description
|
|
4971
|
+
|
|
4972
|
+
<dl>
|
|
4973
|
+
<dd>
|
|
4974
|
+
|
|
4975
|
+
<dl>
|
|
4976
|
+
<dd>
|
|
4977
|
+
|
|
4978
|
+
**CLI:**
|
|
4979
|
+
```bash
|
|
4980
|
+
agentmail pods:api-keys delete --pod-id <pod_id> --api-key-id <api_key_id>
|
|
4981
|
+
```
|
|
4982
|
+
</dd>
|
|
4983
|
+
</dl>
|
|
4984
|
+
</dd>
|
|
4985
|
+
</dl>
|
|
4986
|
+
|
|
3846
4987
|
#### 🔌 Usage
|
|
3847
4988
|
|
|
3848
4989
|
<dl>
|
|
@@ -3901,6 +5042,23 @@ await client.pods.apiKeys.delete("pod_id", "api_key_id");
|
|
|
3901
5042
|
<dl>
|
|
3902
5043
|
<dd>
|
|
3903
5044
|
|
|
5045
|
+
#### 📝 Description
|
|
5046
|
+
|
|
5047
|
+
<dl>
|
|
5048
|
+
<dd>
|
|
5049
|
+
|
|
5050
|
+
<dl>
|
|
5051
|
+
<dd>
|
|
5052
|
+
|
|
5053
|
+
**CLI:**
|
|
5054
|
+
```bash
|
|
5055
|
+
agentmail pods:domains list --pod-id <pod_id>
|
|
5056
|
+
```
|
|
5057
|
+
</dd>
|
|
5058
|
+
</dl>
|
|
5059
|
+
</dd>
|
|
5060
|
+
</dl>
|
|
5061
|
+
|
|
3904
5062
|
#### 🔌 Usage
|
|
3905
5063
|
|
|
3906
5064
|
<dl>
|
|
@@ -3958,6 +5116,23 @@ await client.pods.domains.list("pod_id");
|
|
|
3958
5116
|
<dl>
|
|
3959
5117
|
<dd>
|
|
3960
5118
|
|
|
5119
|
+
#### 📝 Description
|
|
5120
|
+
|
|
5121
|
+
<dl>
|
|
5122
|
+
<dd>
|
|
5123
|
+
|
|
5124
|
+
<dl>
|
|
5125
|
+
<dd>
|
|
5126
|
+
|
|
5127
|
+
**CLI:**
|
|
5128
|
+
```bash
|
|
5129
|
+
agentmail pods:domains retrieve --pod-id <pod_id> --domain-id <domain_id>
|
|
5130
|
+
```
|
|
5131
|
+
</dd>
|
|
5132
|
+
</dl>
|
|
5133
|
+
</dd>
|
|
5134
|
+
</dl>
|
|
5135
|
+
|
|
3961
5136
|
#### 🔌 Usage
|
|
3962
5137
|
|
|
3963
5138
|
<dl>
|
|
@@ -4015,6 +5190,23 @@ await client.pods.domains.get("pod_id", "domain_id");
|
|
|
4015
5190
|
<dl>
|
|
4016
5191
|
<dd>
|
|
4017
5192
|
|
|
5193
|
+
#### 📝 Description
|
|
5194
|
+
|
|
5195
|
+
<dl>
|
|
5196
|
+
<dd>
|
|
5197
|
+
|
|
5198
|
+
<dl>
|
|
5199
|
+
<dd>
|
|
5200
|
+
|
|
5201
|
+
**CLI:**
|
|
5202
|
+
```bash
|
|
5203
|
+
agentmail pods:domains get-zone-file --pod-id <pod_id> --domain-id <domain_id>
|
|
5204
|
+
```
|
|
5205
|
+
</dd>
|
|
5206
|
+
</dl>
|
|
5207
|
+
</dd>
|
|
5208
|
+
</dl>
|
|
5209
|
+
|
|
4018
5210
|
#### 🔌 Usage
|
|
4019
5211
|
|
|
4020
5212
|
<dl>
|
|
@@ -4072,6 +5264,23 @@ await client.pods.domains.getZoneFile("pod_id", "domain_id");
|
|
|
4072
5264
|
<dl>
|
|
4073
5265
|
<dd>
|
|
4074
5266
|
|
|
5267
|
+
#### 📝 Description
|
|
5268
|
+
|
|
5269
|
+
<dl>
|
|
5270
|
+
<dd>
|
|
5271
|
+
|
|
5272
|
+
<dl>
|
|
5273
|
+
<dd>
|
|
5274
|
+
|
|
5275
|
+
**CLI:**
|
|
5276
|
+
```bash
|
|
5277
|
+
agentmail pods:domains create --pod-id <pod_id> --domain example.com
|
|
5278
|
+
```
|
|
5279
|
+
</dd>
|
|
5280
|
+
</dl>
|
|
5281
|
+
</dd>
|
|
5282
|
+
</dl>
|
|
5283
|
+
|
|
4075
5284
|
#### 🔌 Usage
|
|
4076
5285
|
|
|
4077
5286
|
<dl>
|
|
@@ -4132,6 +5341,23 @@ await client.pods.domains.create("pod_id", {
|
|
|
4132
5341
|
<dl>
|
|
4133
5342
|
<dd>
|
|
4134
5343
|
|
|
5344
|
+
#### 📝 Description
|
|
5345
|
+
|
|
5346
|
+
<dl>
|
|
5347
|
+
<dd>
|
|
5348
|
+
|
|
5349
|
+
<dl>
|
|
5350
|
+
<dd>
|
|
5351
|
+
|
|
5352
|
+
**CLI:**
|
|
5353
|
+
```bash
|
|
5354
|
+
agentmail pods:domains update --pod-id <pod_id> --domain-id <domain_id>
|
|
5355
|
+
```
|
|
5356
|
+
</dd>
|
|
5357
|
+
</dl>
|
|
5358
|
+
</dd>
|
|
5359
|
+
</dl>
|
|
5360
|
+
|
|
4135
5361
|
#### 🔌 Usage
|
|
4136
5362
|
|
|
4137
5363
|
<dl>
|
|
@@ -4197,6 +5423,23 @@ await client.pods.domains.update("pod_id", "domain_id", {});
|
|
|
4197
5423
|
<dl>
|
|
4198
5424
|
<dd>
|
|
4199
5425
|
|
|
5426
|
+
#### 📝 Description
|
|
5427
|
+
|
|
5428
|
+
<dl>
|
|
5429
|
+
<dd>
|
|
5430
|
+
|
|
5431
|
+
<dl>
|
|
5432
|
+
<dd>
|
|
5433
|
+
|
|
5434
|
+
**CLI:**
|
|
5435
|
+
```bash
|
|
5436
|
+
agentmail pods:domains delete --pod-id <pod_id> --domain-id <domain_id>
|
|
5437
|
+
```
|
|
5438
|
+
</dd>
|
|
5439
|
+
</dl>
|
|
5440
|
+
</dd>
|
|
5441
|
+
</dl>
|
|
5442
|
+
|
|
4200
5443
|
#### 🔌 Usage
|
|
4201
5444
|
|
|
4202
5445
|
<dl>
|
|
@@ -4254,6 +5497,23 @@ await client.pods.domains.delete("pod_id", "domain_id");
|
|
|
4254
5497
|
<dl>
|
|
4255
5498
|
<dd>
|
|
4256
5499
|
|
|
5500
|
+
#### 📝 Description
|
|
5501
|
+
|
|
5502
|
+
<dl>
|
|
5503
|
+
<dd>
|
|
5504
|
+
|
|
5505
|
+
<dl>
|
|
5506
|
+
<dd>
|
|
5507
|
+
|
|
5508
|
+
**CLI:**
|
|
5509
|
+
```bash
|
|
5510
|
+
agentmail pods:domains verify --pod-id <pod_id> --domain-id <domain_id>
|
|
5511
|
+
```
|
|
5512
|
+
</dd>
|
|
5513
|
+
</dl>
|
|
5514
|
+
</dd>
|
|
5515
|
+
</dl>
|
|
5516
|
+
|
|
4257
5517
|
#### 🔌 Usage
|
|
4258
5518
|
|
|
4259
5519
|
<dl>
|
|
@@ -4312,6 +5572,23 @@ await client.pods.domains.verify("pod_id", "domain_id");
|
|
|
4312
5572
|
<dl>
|
|
4313
5573
|
<dd>
|
|
4314
5574
|
|
|
5575
|
+
#### 📝 Description
|
|
5576
|
+
|
|
5577
|
+
<dl>
|
|
5578
|
+
<dd>
|
|
5579
|
+
|
|
5580
|
+
<dl>
|
|
5581
|
+
<dd>
|
|
5582
|
+
|
|
5583
|
+
**CLI:**
|
|
5584
|
+
```bash
|
|
5585
|
+
agentmail pods:drafts list --pod-id <pod_id>
|
|
5586
|
+
```
|
|
5587
|
+
</dd>
|
|
5588
|
+
</dl>
|
|
5589
|
+
</dd>
|
|
5590
|
+
</dl>
|
|
5591
|
+
|
|
4315
5592
|
#### 🔌 Usage
|
|
4316
5593
|
|
|
4317
5594
|
<dl>
|
|
@@ -4369,6 +5646,23 @@ await client.pods.drafts.list("pod_id");
|
|
|
4369
5646
|
<dl>
|
|
4370
5647
|
<dd>
|
|
4371
5648
|
|
|
5649
|
+
#### 📝 Description
|
|
5650
|
+
|
|
5651
|
+
<dl>
|
|
5652
|
+
<dd>
|
|
5653
|
+
|
|
5654
|
+
<dl>
|
|
5655
|
+
<dd>
|
|
5656
|
+
|
|
5657
|
+
**CLI:**
|
|
5658
|
+
```bash
|
|
5659
|
+
agentmail pods:drafts retrieve --pod-id <pod_id> --draft-id <draft_id>
|
|
5660
|
+
```
|
|
5661
|
+
</dd>
|
|
5662
|
+
</dl>
|
|
5663
|
+
</dd>
|
|
5664
|
+
</dl>
|
|
5665
|
+
|
|
4372
5666
|
#### 🔌 Usage
|
|
4373
5667
|
|
|
4374
5668
|
<dl>
|
|
@@ -4426,6 +5720,23 @@ await client.pods.drafts.get("pod_id", "draft_id");
|
|
|
4426
5720
|
<dl>
|
|
4427
5721
|
<dd>
|
|
4428
5722
|
|
|
5723
|
+
#### 📝 Description
|
|
5724
|
+
|
|
5725
|
+
<dl>
|
|
5726
|
+
<dd>
|
|
5727
|
+
|
|
5728
|
+
<dl>
|
|
5729
|
+
<dd>
|
|
5730
|
+
|
|
5731
|
+
**CLI:**
|
|
5732
|
+
```bash
|
|
5733
|
+
agentmail pods:drafts get-attachment --pod-id <pod_id> --draft-id <draft_id> --attachment-id <attachment_id>
|
|
5734
|
+
```
|
|
5735
|
+
</dd>
|
|
5736
|
+
</dl>
|
|
5737
|
+
</dd>
|
|
5738
|
+
</dl>
|
|
5739
|
+
|
|
4429
5740
|
#### 🔌 Usage
|
|
4430
5741
|
|
|
4431
5742
|
<dl>
|
|
@@ -4492,6 +5803,23 @@ await client.pods.drafts.getAttachment("pod_id", "draft_id", "attachment_id");
|
|
|
4492
5803
|
<dl>
|
|
4493
5804
|
<dd>
|
|
4494
5805
|
|
|
5806
|
+
#### 📝 Description
|
|
5807
|
+
|
|
5808
|
+
<dl>
|
|
5809
|
+
<dd>
|
|
5810
|
+
|
|
5811
|
+
<dl>
|
|
5812
|
+
<dd>
|
|
5813
|
+
|
|
5814
|
+
**CLI:**
|
|
5815
|
+
```bash
|
|
5816
|
+
agentmail pods:inboxes list --pod-id <pod_id>
|
|
5817
|
+
```
|
|
5818
|
+
</dd>
|
|
5819
|
+
</dl>
|
|
5820
|
+
</dd>
|
|
5821
|
+
</dl>
|
|
5822
|
+
|
|
4495
5823
|
#### 🔌 Usage
|
|
4496
5824
|
|
|
4497
5825
|
<dl>
|
|
@@ -4549,6 +5877,23 @@ await client.pods.inboxes.list("pod_id");
|
|
|
4549
5877
|
<dl>
|
|
4550
5878
|
<dd>
|
|
4551
5879
|
|
|
5880
|
+
#### 📝 Description
|
|
5881
|
+
|
|
5882
|
+
<dl>
|
|
5883
|
+
<dd>
|
|
5884
|
+
|
|
5885
|
+
<dl>
|
|
5886
|
+
<dd>
|
|
5887
|
+
|
|
5888
|
+
**CLI:**
|
|
5889
|
+
```bash
|
|
5890
|
+
agentmail pods:inboxes retrieve --pod-id <pod_id> --inbox-id <inbox_id>
|
|
5891
|
+
```
|
|
5892
|
+
</dd>
|
|
5893
|
+
</dl>
|
|
5894
|
+
</dd>
|
|
5895
|
+
</dl>
|
|
5896
|
+
|
|
4552
5897
|
#### 🔌 Usage
|
|
4553
5898
|
|
|
4554
5899
|
<dl>
|
|
@@ -4606,6 +5951,23 @@ await client.pods.inboxes.get("pod_id", "inbox_id");
|
|
|
4606
5951
|
<dl>
|
|
4607
5952
|
<dd>
|
|
4608
5953
|
|
|
5954
|
+
#### 📝 Description
|
|
5955
|
+
|
|
5956
|
+
<dl>
|
|
5957
|
+
<dd>
|
|
5958
|
+
|
|
5959
|
+
<dl>
|
|
5960
|
+
<dd>
|
|
5961
|
+
|
|
5962
|
+
**CLI:**
|
|
5963
|
+
```bash
|
|
5964
|
+
agentmail pods:inboxes create --pod-id <pod_id> --username myagent --domain example.com
|
|
5965
|
+
```
|
|
5966
|
+
</dd>
|
|
5967
|
+
</dl>
|
|
5968
|
+
</dd>
|
|
5969
|
+
</dl>
|
|
5970
|
+
|
|
4609
5971
|
#### 🔌 Usage
|
|
4610
5972
|
|
|
4611
5973
|
<dl>
|
|
@@ -4663,6 +6025,23 @@ await client.pods.inboxes.create("pod_id", {});
|
|
|
4663
6025
|
<dl>
|
|
4664
6026
|
<dd>
|
|
4665
6027
|
|
|
6028
|
+
#### 📝 Description
|
|
6029
|
+
|
|
6030
|
+
<dl>
|
|
6031
|
+
<dd>
|
|
6032
|
+
|
|
6033
|
+
<dl>
|
|
6034
|
+
<dd>
|
|
6035
|
+
|
|
6036
|
+
**CLI:**
|
|
6037
|
+
```bash
|
|
6038
|
+
agentmail pods:inboxes update --pod-id <pod_id> --inbox-id <inbox_id>
|
|
6039
|
+
```
|
|
6040
|
+
</dd>
|
|
6041
|
+
</dl>
|
|
6042
|
+
</dd>
|
|
6043
|
+
</dl>
|
|
6044
|
+
|
|
4666
6045
|
#### 🔌 Usage
|
|
4667
6046
|
|
|
4668
6047
|
<dl>
|
|
@@ -4730,6 +6109,23 @@ await client.pods.inboxes.update("pod_id", "inbox_id", {
|
|
|
4730
6109
|
<dl>
|
|
4731
6110
|
<dd>
|
|
4732
6111
|
|
|
6112
|
+
#### 📝 Description
|
|
6113
|
+
|
|
6114
|
+
<dl>
|
|
6115
|
+
<dd>
|
|
6116
|
+
|
|
6117
|
+
<dl>
|
|
6118
|
+
<dd>
|
|
6119
|
+
|
|
6120
|
+
**CLI:**
|
|
6121
|
+
```bash
|
|
6122
|
+
agentmail pods:inboxes delete --pod-id <pod_id> --inbox-id <inbox_id>
|
|
6123
|
+
```
|
|
6124
|
+
</dd>
|
|
6125
|
+
</dl>
|
|
6126
|
+
</dd>
|
|
6127
|
+
</dl>
|
|
6128
|
+
|
|
4733
6129
|
#### 🔌 Usage
|
|
4734
6130
|
|
|
4735
6131
|
<dl>
|
|
@@ -4788,6 +6184,23 @@ await client.pods.inboxes.delete("pod_id", "inbox_id");
|
|
|
4788
6184
|
<dl>
|
|
4789
6185
|
<dd>
|
|
4790
6186
|
|
|
6187
|
+
#### 📝 Description
|
|
6188
|
+
|
|
6189
|
+
<dl>
|
|
6190
|
+
<dd>
|
|
6191
|
+
|
|
6192
|
+
<dl>
|
|
6193
|
+
<dd>
|
|
6194
|
+
|
|
6195
|
+
**CLI:**
|
|
6196
|
+
```bash
|
|
6197
|
+
agentmail pods:lists list --pod-id <pod_id> --direction <direction> --type <type>
|
|
6198
|
+
```
|
|
6199
|
+
</dd>
|
|
6200
|
+
</dl>
|
|
6201
|
+
</dd>
|
|
6202
|
+
</dl>
|
|
6203
|
+
|
|
4791
6204
|
#### 🔌 Usage
|
|
4792
6205
|
|
|
4793
6206
|
<dl>
|
|
@@ -4861,6 +6274,23 @@ await client.pods.lists.list("pod_id", "send", "allow");
|
|
|
4861
6274
|
<dl>
|
|
4862
6275
|
<dd>
|
|
4863
6276
|
|
|
6277
|
+
#### 📝 Description
|
|
6278
|
+
|
|
6279
|
+
<dl>
|
|
6280
|
+
<dd>
|
|
6281
|
+
|
|
6282
|
+
<dl>
|
|
6283
|
+
<dd>
|
|
6284
|
+
|
|
6285
|
+
**CLI:**
|
|
6286
|
+
```bash
|
|
6287
|
+
agentmail pods:lists retrieve --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
6288
|
+
```
|
|
6289
|
+
</dd>
|
|
6290
|
+
</dl>
|
|
6291
|
+
</dd>
|
|
6292
|
+
</dl>
|
|
6293
|
+
|
|
4864
6294
|
#### 🔌 Usage
|
|
4865
6295
|
|
|
4866
6296
|
<dl>
|
|
@@ -4934,6 +6364,23 @@ await client.pods.lists.get("pod_id", "send", "allow", "entry");
|
|
|
4934
6364
|
<dl>
|
|
4935
6365
|
<dd>
|
|
4936
6366
|
|
|
6367
|
+
#### 📝 Description
|
|
6368
|
+
|
|
6369
|
+
<dl>
|
|
6370
|
+
<dd>
|
|
6371
|
+
|
|
6372
|
+
<dl>
|
|
6373
|
+
<dd>
|
|
6374
|
+
|
|
6375
|
+
**CLI:**
|
|
6376
|
+
```bash
|
|
6377
|
+
agentmail pods:lists create --pod-id <pod_id> --direction <direction> --type <type> --entry user@example.com
|
|
6378
|
+
```
|
|
6379
|
+
</dd>
|
|
6380
|
+
</dl>
|
|
6381
|
+
</dd>
|
|
6382
|
+
</dl>
|
|
6383
|
+
|
|
4937
6384
|
#### 🔌 Usage
|
|
4938
6385
|
|
|
4939
6386
|
<dl>
|
|
@@ -5009,6 +6456,23 @@ await client.pods.lists.create("pod_id", "send", "allow", {
|
|
|
5009
6456
|
<dl>
|
|
5010
6457
|
<dd>
|
|
5011
6458
|
|
|
6459
|
+
#### 📝 Description
|
|
6460
|
+
|
|
6461
|
+
<dl>
|
|
6462
|
+
<dd>
|
|
6463
|
+
|
|
6464
|
+
<dl>
|
|
6465
|
+
<dd>
|
|
6466
|
+
|
|
6467
|
+
**CLI:**
|
|
6468
|
+
```bash
|
|
6469
|
+
agentmail pods:lists delete --pod-id <pod_id> --direction <direction> --type <type> --entry <entry>
|
|
6470
|
+
```
|
|
6471
|
+
</dd>
|
|
6472
|
+
</dl>
|
|
6473
|
+
</dd>
|
|
6474
|
+
</dl>
|
|
6475
|
+
|
|
5012
6476
|
#### 🔌 Usage
|
|
5013
6477
|
|
|
5014
6478
|
<dl>
|
|
@@ -5083,6 +6547,23 @@ await client.pods.lists.delete("pod_id", "send", "allow", "entry");
|
|
|
5083
6547
|
<dl>
|
|
5084
6548
|
<dd>
|
|
5085
6549
|
|
|
6550
|
+
#### 📝 Description
|
|
6551
|
+
|
|
6552
|
+
<dl>
|
|
6553
|
+
<dd>
|
|
6554
|
+
|
|
6555
|
+
<dl>
|
|
6556
|
+
<dd>
|
|
6557
|
+
|
|
6558
|
+
**CLI:**
|
|
6559
|
+
```bash
|
|
6560
|
+
agentmail pods:metrics query --pod-id <pod_id>
|
|
6561
|
+
```
|
|
6562
|
+
</dd>
|
|
6563
|
+
</dl>
|
|
6564
|
+
</dd>
|
|
6565
|
+
</dl>
|
|
6566
|
+
|
|
5086
6567
|
#### 🔌 Usage
|
|
5087
6568
|
|
|
5088
6569
|
<dl>
|
|
@@ -5141,6 +6622,23 @@ await client.pods.metrics.query("pod_id");
|
|
|
5141
6622
|
<dl>
|
|
5142
6623
|
<dd>
|
|
5143
6624
|
|
|
6625
|
+
#### 📝 Description
|
|
6626
|
+
|
|
6627
|
+
<dl>
|
|
6628
|
+
<dd>
|
|
6629
|
+
|
|
6630
|
+
<dl>
|
|
6631
|
+
<dd>
|
|
6632
|
+
|
|
6633
|
+
**CLI:**
|
|
6634
|
+
```bash
|
|
6635
|
+
agentmail pods:threads list --pod-id <pod_id>
|
|
6636
|
+
```
|
|
6637
|
+
</dd>
|
|
6638
|
+
</dl>
|
|
6639
|
+
</dd>
|
|
6640
|
+
</dl>
|
|
6641
|
+
|
|
5144
6642
|
#### 🔌 Usage
|
|
5145
6643
|
|
|
5146
6644
|
<dl>
|
|
@@ -5198,6 +6696,23 @@ await client.pods.threads.list("pod_id");
|
|
|
5198
6696
|
<dl>
|
|
5199
6697
|
<dd>
|
|
5200
6698
|
|
|
6699
|
+
#### 📝 Description
|
|
6700
|
+
|
|
6701
|
+
<dl>
|
|
6702
|
+
<dd>
|
|
6703
|
+
|
|
6704
|
+
<dl>
|
|
6705
|
+
<dd>
|
|
6706
|
+
|
|
6707
|
+
**CLI:**
|
|
6708
|
+
```bash
|
|
6709
|
+
agentmail pods:threads retrieve --pod-id <pod_id> --thread-id <thread_id>
|
|
6710
|
+
```
|
|
6711
|
+
</dd>
|
|
6712
|
+
</dl>
|
|
6713
|
+
</dd>
|
|
6714
|
+
</dl>
|
|
6715
|
+
|
|
5201
6716
|
#### 🔌 Usage
|
|
5202
6717
|
|
|
5203
6718
|
<dl>
|
|
@@ -5255,6 +6770,23 @@ await client.pods.threads.get("pod_id", "thread_id");
|
|
|
5255
6770
|
<dl>
|
|
5256
6771
|
<dd>
|
|
5257
6772
|
|
|
6773
|
+
#### 📝 Description
|
|
6774
|
+
|
|
6775
|
+
<dl>
|
|
6776
|
+
<dd>
|
|
6777
|
+
|
|
6778
|
+
<dl>
|
|
6779
|
+
<dd>
|
|
6780
|
+
|
|
6781
|
+
**CLI:**
|
|
6782
|
+
```bash
|
|
6783
|
+
agentmail pods:threads get-attachment --pod-id <pod_id> --thread-id <thread_id> --attachment-id <attachment_id>
|
|
6784
|
+
```
|
|
6785
|
+
</dd>
|
|
6786
|
+
</dl>
|
|
6787
|
+
</dd>
|
|
6788
|
+
</dl>
|
|
6789
|
+
|
|
5258
6790
|
#### 🔌 Usage
|
|
5259
6791
|
|
|
5260
6792
|
<dl>
|
|
@@ -5408,6 +6940,11 @@ await client.pods.threads.update("pod_id", "thread_id", {});
|
|
|
5408
6940
|
<dd>
|
|
5409
6941
|
|
|
5410
6942
|
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.
|
|
6943
|
+
|
|
6944
|
+
**CLI:**
|
|
6945
|
+
```bash
|
|
6946
|
+
agentmail pods:threads delete --pod-id <pod_id> --thread-id <thread_id>
|
|
6947
|
+
```
|
|
5411
6948
|
</dd>
|
|
5412
6949
|
</dl>
|
|
5413
6950
|
</dd>
|
|
@@ -5479,6 +7016,23 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
5479
7016
|
<dl>
|
|
5480
7017
|
<dd>
|
|
5481
7018
|
|
|
7019
|
+
#### 📝 Description
|
|
7020
|
+
|
|
7021
|
+
<dl>
|
|
7022
|
+
<dd>
|
|
7023
|
+
|
|
7024
|
+
<dl>
|
|
7025
|
+
<dd>
|
|
7026
|
+
|
|
7027
|
+
**CLI:**
|
|
7028
|
+
```bash
|
|
7029
|
+
agentmail threads list
|
|
7030
|
+
```
|
|
7031
|
+
</dd>
|
|
7032
|
+
</dl>
|
|
7033
|
+
</dd>
|
|
7034
|
+
</dl>
|
|
7035
|
+
|
|
5482
7036
|
#### 🔌 Usage
|
|
5483
7037
|
|
|
5484
7038
|
<dl>
|
|
@@ -5528,6 +7082,23 @@ await client.threads.list();
|
|
|
5528
7082
|
<dl>
|
|
5529
7083
|
<dd>
|
|
5530
7084
|
|
|
7085
|
+
#### 📝 Description
|
|
7086
|
+
|
|
7087
|
+
<dl>
|
|
7088
|
+
<dd>
|
|
7089
|
+
|
|
7090
|
+
<dl>
|
|
7091
|
+
<dd>
|
|
7092
|
+
|
|
7093
|
+
**CLI:**
|
|
7094
|
+
```bash
|
|
7095
|
+
agentmail threads retrieve --thread-id <thread_id>
|
|
7096
|
+
```
|
|
7097
|
+
</dd>
|
|
7098
|
+
</dl>
|
|
7099
|
+
</dd>
|
|
7100
|
+
</dl>
|
|
7101
|
+
|
|
5531
7102
|
#### 🔌 Usage
|
|
5532
7103
|
|
|
5533
7104
|
<dl>
|
|
@@ -5577,6 +7148,23 @@ await client.threads.get("thread_id");
|
|
|
5577
7148
|
<dl>
|
|
5578
7149
|
<dd>
|
|
5579
7150
|
|
|
7151
|
+
#### 📝 Description
|
|
7152
|
+
|
|
7153
|
+
<dl>
|
|
7154
|
+
<dd>
|
|
7155
|
+
|
|
7156
|
+
<dl>
|
|
7157
|
+
<dd>
|
|
7158
|
+
|
|
7159
|
+
**CLI:**
|
|
7160
|
+
```bash
|
|
7161
|
+
agentmail threads retrieve-attachment --thread-id <thread_id> --attachment-id <attachment_id>
|
|
7162
|
+
```
|
|
7163
|
+
</dd>
|
|
7164
|
+
</dl>
|
|
7165
|
+
</dd>
|
|
7166
|
+
</dl>
|
|
7167
|
+
|
|
5580
7168
|
#### 🔌 Usage
|
|
5581
7169
|
|
|
5582
7170
|
<dl>
|
|
@@ -5714,6 +7302,11 @@ await client.threads.update("thread_id", {});
|
|
|
5714
7302
|
<dd>
|
|
5715
7303
|
|
|
5716
7304
|
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.
|
|
7305
|
+
|
|
7306
|
+
**CLI:**
|
|
7307
|
+
```bash
|
|
7308
|
+
agentmail threads delete --thread-id <thread_id>
|
|
7309
|
+
```
|
|
5717
7310
|
</dd>
|
|
5718
7311
|
</dl>
|
|
5719
7312
|
</dd>
|