agentmail 0.5.8 → 0.5.9
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/inboxes/resources/messages/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/Client.js +101 -1
- package/dist/cjs/api/resources/inboxes/resources/messages/client/requests/ListMessagesRequest.d.ts +6 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/requests/SearchMessagesRequest.d.ts +14 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/requests/SearchMessagesRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/messages/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/Client.js +100 -1
- package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/ListThreadsRequest.d.ts +6 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/SearchThreadsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/SearchThreadsRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/threads/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/SearchMessageHighlights.d.ts +15 -0
- package/dist/cjs/api/resources/messages/types/SearchMessageHighlights.js +3 -0
- package/dist/cjs/api/resources/messages/types/SearchMessageItem.d.ts +5 -0
- package/dist/cjs/api/resources/messages/types/SearchMessageItem.js +3 -0
- package/dist/cjs/api/resources/messages/types/SearchMessagesResponse.d.ts +8 -0
- package/dist/cjs/api/resources/messages/types/SearchMessagesResponse.js +3 -0
- package/dist/cjs/api/resources/messages/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/messages/types/index.js +3 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.d.ts +25 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/Client.js +100 -1
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/ListThreadsRequest.d.ts +6 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/SearchThreadsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/SearchThreadsRequest.js +3 -0
- package/dist/cjs/api/resources/pods/resources/threads/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/threads/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/threads/client/Client.js +101 -1
- package/dist/cjs/api/resources/threads/client/requests/ListThreadsRequest.d.ts +6 -0
- package/dist/cjs/api/resources/threads/client/requests/SearchThreadsRequest.d.ts +14 -0
- package/dist/cjs/api/resources/threads/client/requests/SearchThreadsRequest.js +3 -0
- package/dist/cjs/api/resources/threads/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/threads/types/SearchThreadHighlights.d.ts +15 -0
- package/dist/cjs/api/resources/threads/types/SearchThreadHighlights.js +3 -0
- package/dist/cjs/api/resources/threads/types/SearchThreadItem.d.ts +5 -0
- package/dist/cjs/api/resources/threads/types/SearchThreadItem.js +3 -0
- package/dist/cjs/api/resources/threads/types/SearchThreadsResponse.d.ts +8 -0
- package/dist/cjs/api/resources/threads/types/SearchThreadsResponse.js +3 -0
- package/dist/cjs/api/resources/threads/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/threads/types/index.js +3 -0
- package/dist/cjs/api/types/Query.d.ts +5 -0
- package/dist/cjs/api/types/Query.js +3 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -0
- package/dist/cjs/serialization/resources/messages/types/SearchMessageHighlights.d.ts +12 -0
- package/dist/cjs/serialization/resources/messages/types/SearchMessageHighlights.js +44 -0
- package/dist/cjs/serialization/resources/messages/types/SearchMessageItem.d.ts +11 -0
- package/dist/cjs/serialization/resources/messages/types/SearchMessageItem.js +45 -0
- package/dist/cjs/serialization/resources/messages/types/SearchMessagesResponse.d.ts +16 -0
- package/dist/cjs/serialization/resources/messages/types/SearchMessagesResponse.js +48 -0
- package/dist/cjs/serialization/resources/messages/types/index.d.ts +3 -0
- package/dist/cjs/serialization/resources/messages/types/index.js +3 -0
- package/dist/cjs/serialization/resources/threads/types/SearchThreadHighlights.d.ts +12 -0
- package/dist/cjs/serialization/resources/threads/types/SearchThreadHighlights.js +44 -0
- package/dist/cjs/serialization/resources/threads/types/SearchThreadItem.d.ts +11 -0
- package/dist/cjs/serialization/resources/threads/types/SearchThreadItem.js +45 -0
- package/dist/cjs/serialization/resources/threads/types/SearchThreadsResponse.d.ts +16 -0
- package/dist/cjs/serialization/resources/threads/types/SearchThreadsResponse.js +48 -0
- package/dist/cjs/serialization/resources/threads/types/index.d.ts +3 -0
- package/dist/cjs/serialization/resources/threads/types/index.js +3 -0
- package/dist/cjs/serialization/types/Query.d.ts +7 -0
- package/dist/cjs/serialization/types/Query.js +39 -0
- package/dist/cjs/serialization/types/index.d.ts +1 -0
- package/dist/cjs/serialization/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/inboxes/resources/messages/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/Client.mjs +101 -1
- package/dist/esm/api/resources/inboxes/resources/messages/client/requests/ListMessagesRequest.d.mts +6 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/requests/SearchMessagesRequest.d.mts +14 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/requests/SearchMessagesRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/messages/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/Client.mjs +100 -1
- package/dist/esm/api/resources/inboxes/resources/threads/client/requests/ListThreadsRequest.d.mts +6 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/requests/SearchThreadsRequest.d.mts +14 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/requests/SearchThreadsRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/threads/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/SearchMessageHighlights.d.mts +15 -0
- package/dist/esm/api/resources/messages/types/SearchMessageHighlights.mjs +2 -0
- package/dist/esm/api/resources/messages/types/SearchMessageItem.d.mts +5 -0
- package/dist/esm/api/resources/messages/types/SearchMessageItem.mjs +2 -0
- package/dist/esm/api/resources/messages/types/SearchMessagesResponse.d.mts +8 -0
- package/dist/esm/api/resources/messages/types/SearchMessagesResponse.mjs +2 -0
- package/dist/esm/api/resources/messages/types/index.d.mts +3 -0
- package/dist/esm/api/resources/messages/types/index.mjs +3 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.d.mts +25 -0
- package/dist/esm/api/resources/pods/resources/threads/client/Client.mjs +100 -1
- package/dist/esm/api/resources/pods/resources/threads/client/requests/ListThreadsRequest.d.mts +6 -0
- package/dist/esm/api/resources/pods/resources/threads/client/requests/SearchThreadsRequest.d.mts +14 -0
- package/dist/esm/api/resources/pods/resources/threads/client/requests/SearchThreadsRequest.mjs +2 -0
- package/dist/esm/api/resources/pods/resources/threads/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/threads/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/threads/client/Client.mjs +101 -1
- package/dist/esm/api/resources/threads/client/requests/ListThreadsRequest.d.mts +6 -0
- package/dist/esm/api/resources/threads/client/requests/SearchThreadsRequest.d.mts +14 -0
- package/dist/esm/api/resources/threads/client/requests/SearchThreadsRequest.mjs +2 -0
- package/dist/esm/api/resources/threads/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/threads/types/SearchThreadHighlights.d.mts +15 -0
- package/dist/esm/api/resources/threads/types/SearchThreadHighlights.mjs +2 -0
- package/dist/esm/api/resources/threads/types/SearchThreadItem.d.mts +5 -0
- package/dist/esm/api/resources/threads/types/SearchThreadItem.mjs +2 -0
- package/dist/esm/api/resources/threads/types/SearchThreadsResponse.d.mts +8 -0
- package/dist/esm/api/resources/threads/types/SearchThreadsResponse.mjs +2 -0
- package/dist/esm/api/resources/threads/types/index.d.mts +3 -0
- package/dist/esm/api/resources/threads/types/index.mjs +3 -0
- package/dist/esm/api/types/Query.d.mts +5 -0
- package/dist/esm/api/types/Query.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/messages/types/SearchMessageHighlights.d.mts +12 -0
- package/dist/esm/serialization/resources/messages/types/SearchMessageHighlights.mjs +8 -0
- package/dist/esm/serialization/resources/messages/types/SearchMessageItem.d.mts +11 -0
- package/dist/esm/serialization/resources/messages/types/SearchMessageItem.mjs +9 -0
- package/dist/esm/serialization/resources/messages/types/SearchMessagesResponse.d.mts +16 -0
- package/dist/esm/serialization/resources/messages/types/SearchMessagesResponse.mjs +12 -0
- package/dist/esm/serialization/resources/messages/types/index.d.mts +3 -0
- package/dist/esm/serialization/resources/messages/types/index.mjs +3 -0
- package/dist/esm/serialization/resources/threads/types/SearchThreadHighlights.d.mts +12 -0
- package/dist/esm/serialization/resources/threads/types/SearchThreadHighlights.mjs +8 -0
- package/dist/esm/serialization/resources/threads/types/SearchThreadItem.d.mts +11 -0
- package/dist/esm/serialization/resources/threads/types/SearchThreadItem.mjs +9 -0
- package/dist/esm/serialization/resources/threads/types/SearchThreadsResponse.d.mts +16 -0
- package/dist/esm/serialization/resources/threads/types/SearchThreadsResponse.mjs +12 -0
- package/dist/esm/serialization/resources/threads/types/index.d.mts +3 -0
- package/dist/esm/serialization/resources/threads/types/index.mjs +3 -0
- package/dist/esm/serialization/types/Query.d.mts +7 -0
- package/dist/esm/serialization/types/Query.mjs +3 -0
- package/dist/esm/serialization/types/index.d.mts +1 -0
- package/dist/esm/serialization/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +319 -0
package/reference.md
CHANGED
|
@@ -3260,6 +3260,12 @@ await client.inboxes.lists.delete("inbox_id", "send", "allow", "entry");
|
|
|
3260
3260
|
<dl>
|
|
3261
3261
|
<dd>
|
|
3262
3262
|
|
|
3263
|
+
Lists messages in the inbox, most recent first. Pass `from`, `to`, or
|
|
3264
|
+
`subject` to filter by substring. Filtered requests are served by
|
|
3265
|
+
search, which caps `limit` at 100. For relevance-ranked full-text
|
|
3266
|
+
search across sender, recipients, subject, and message body, use
|
|
3267
|
+
`Search Messages`.
|
|
3268
|
+
|
|
3263
3269
|
**CLI:**
|
|
3264
3270
|
```bash
|
|
3265
3271
|
agentmail inboxes:messages list --inbox-id <inbox_id>
|
|
@@ -3318,6 +3324,82 @@ await client.inboxes.messages.list("inbox_id");
|
|
|
3318
3324
|
</dl>
|
|
3319
3325
|
|
|
3320
3326
|
|
|
3327
|
+
</dd>
|
|
3328
|
+
</dl>
|
|
3329
|
+
</details>
|
|
3330
|
+
|
|
3331
|
+
<details><summary><code>client.inboxes.messages.<a href="/src/api/resources/inboxes/resources/messages/client/Client.ts">search</a>(inbox_id, { ...params }) -> AgentMail.SearchMessagesResponse</code></summary>
|
|
3332
|
+
<dl>
|
|
3333
|
+
<dd>
|
|
3334
|
+
|
|
3335
|
+
#### 📝 Description
|
|
3336
|
+
|
|
3337
|
+
<dl>
|
|
3338
|
+
<dd>
|
|
3339
|
+
|
|
3340
|
+
<dl>
|
|
3341
|
+
<dd>
|
|
3342
|
+
|
|
3343
|
+
Full-text search across messages in the inbox, ranked by relevance. The
|
|
3344
|
+
query is matched against the sender, recipients, and subject (substring)
|
|
3345
|
+
and the message body (tokenized full text). Spam, trash, blocked, and
|
|
3346
|
+
unauthenticated messages are always excluded. `limit` cannot exceed 100.
|
|
3347
|
+
</dd>
|
|
3348
|
+
</dl>
|
|
3349
|
+
</dd>
|
|
3350
|
+
</dl>
|
|
3351
|
+
|
|
3352
|
+
#### 🔌 Usage
|
|
3353
|
+
|
|
3354
|
+
<dl>
|
|
3355
|
+
<dd>
|
|
3356
|
+
|
|
3357
|
+
<dl>
|
|
3358
|
+
<dd>
|
|
3359
|
+
|
|
3360
|
+
```typescript
|
|
3361
|
+
await client.inboxes.messages.search("inbox_id", {
|
|
3362
|
+
q: "q"
|
|
3363
|
+
});
|
|
3364
|
+
|
|
3365
|
+
```
|
|
3366
|
+
</dd>
|
|
3367
|
+
</dl>
|
|
3368
|
+
</dd>
|
|
3369
|
+
</dl>
|
|
3370
|
+
|
|
3371
|
+
#### ⚙️ Parameters
|
|
3372
|
+
|
|
3373
|
+
<dl>
|
|
3374
|
+
<dd>
|
|
3375
|
+
|
|
3376
|
+
<dl>
|
|
3377
|
+
<dd>
|
|
3378
|
+
|
|
3379
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
3380
|
+
|
|
3381
|
+
</dd>
|
|
3382
|
+
</dl>
|
|
3383
|
+
|
|
3384
|
+
<dl>
|
|
3385
|
+
<dd>
|
|
3386
|
+
|
|
3387
|
+
**request:** `AgentMail.inboxes.SearchMessagesRequest`
|
|
3388
|
+
|
|
3389
|
+
</dd>
|
|
3390
|
+
</dl>
|
|
3391
|
+
|
|
3392
|
+
<dl>
|
|
3393
|
+
<dd>
|
|
3394
|
+
|
|
3395
|
+
**requestOptions:** `MessagesClient.RequestOptions`
|
|
3396
|
+
|
|
3397
|
+
</dd>
|
|
3398
|
+
</dl>
|
|
3399
|
+
</dd>
|
|
3400
|
+
</dl>
|
|
3401
|
+
|
|
3402
|
+
|
|
3321
3403
|
</dd>
|
|
3322
3404
|
</dl>
|
|
3323
3405
|
</details>
|
|
@@ -4198,6 +4280,11 @@ await client.inboxes.metrics.query("inbox_id");
|
|
|
4198
4280
|
<dl>
|
|
4199
4281
|
<dd>
|
|
4200
4282
|
|
|
4283
|
+
Lists threads in the inbox, most recent first. Pass `senders`,
|
|
4284
|
+
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
4285
|
+
served by search, which caps `limit` at 100. For relevance-ranked
|
|
4286
|
+
full-text search, use `Search Threads`.
|
|
4287
|
+
|
|
4201
4288
|
**CLI:**
|
|
4202
4289
|
```bash
|
|
4203
4290
|
agentmail inboxes:threads list --inbox-id <inbox_id>
|
|
@@ -4256,6 +4343,82 @@ await client.inboxes.threads.list("inbox_id");
|
|
|
4256
4343
|
</dl>
|
|
4257
4344
|
|
|
4258
4345
|
|
|
4346
|
+
</dd>
|
|
4347
|
+
</dl>
|
|
4348
|
+
</details>
|
|
4349
|
+
|
|
4350
|
+
<details><summary><code>client.inboxes.threads.<a href="/src/api/resources/inboxes/resources/threads/client/Client.ts">search</a>(inbox_id, { ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
|
|
4351
|
+
<dl>
|
|
4352
|
+
<dd>
|
|
4353
|
+
|
|
4354
|
+
#### 📝 Description
|
|
4355
|
+
|
|
4356
|
+
<dl>
|
|
4357
|
+
<dd>
|
|
4358
|
+
|
|
4359
|
+
<dl>
|
|
4360
|
+
<dd>
|
|
4361
|
+
|
|
4362
|
+
Full-text search across threads in the inbox, ranked by relevance. The
|
|
4363
|
+
query is matched against senders, recipients, and subject (substring)
|
|
4364
|
+
and the message body (tokenized full text). Spam, trash, blocked, and
|
|
4365
|
+
unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
4366
|
+
</dd>
|
|
4367
|
+
</dl>
|
|
4368
|
+
</dd>
|
|
4369
|
+
</dl>
|
|
4370
|
+
|
|
4371
|
+
#### 🔌 Usage
|
|
4372
|
+
|
|
4373
|
+
<dl>
|
|
4374
|
+
<dd>
|
|
4375
|
+
|
|
4376
|
+
<dl>
|
|
4377
|
+
<dd>
|
|
4378
|
+
|
|
4379
|
+
```typescript
|
|
4380
|
+
await client.inboxes.threads.search("inbox_id", {
|
|
4381
|
+
q: "q"
|
|
4382
|
+
});
|
|
4383
|
+
|
|
4384
|
+
```
|
|
4385
|
+
</dd>
|
|
4386
|
+
</dl>
|
|
4387
|
+
</dd>
|
|
4388
|
+
</dl>
|
|
4389
|
+
|
|
4390
|
+
#### ⚙️ Parameters
|
|
4391
|
+
|
|
4392
|
+
<dl>
|
|
4393
|
+
<dd>
|
|
4394
|
+
|
|
4395
|
+
<dl>
|
|
4396
|
+
<dd>
|
|
4397
|
+
|
|
4398
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
4399
|
+
|
|
4400
|
+
</dd>
|
|
4401
|
+
</dl>
|
|
4402
|
+
|
|
4403
|
+
<dl>
|
|
4404
|
+
<dd>
|
|
4405
|
+
|
|
4406
|
+
**request:** `AgentMail.inboxes.SearchThreadsRequest`
|
|
4407
|
+
|
|
4408
|
+
</dd>
|
|
4409
|
+
</dl>
|
|
4410
|
+
|
|
4411
|
+
<dl>
|
|
4412
|
+
<dd>
|
|
4413
|
+
|
|
4414
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
4415
|
+
|
|
4416
|
+
</dd>
|
|
4417
|
+
</dl>
|
|
4418
|
+
</dd>
|
|
4419
|
+
</dl>
|
|
4420
|
+
|
|
4421
|
+
|
|
4259
4422
|
</dd>
|
|
4260
4423
|
</dl>
|
|
4261
4424
|
</details>
|
|
@@ -6852,6 +7015,11 @@ await client.pods.metrics.query("pod_id");
|
|
|
6852
7015
|
<dl>
|
|
6853
7016
|
<dd>
|
|
6854
7017
|
|
|
7018
|
+
Lists threads in the pod, most recent first. Pass `senders`,
|
|
7019
|
+
`recipients`, or `subject` to filter by substring. Filtered requests are
|
|
7020
|
+
served by search, which caps `limit` at 100. For relevance-ranked
|
|
7021
|
+
full-text search, use `Search Threads`.
|
|
7022
|
+
|
|
6855
7023
|
**CLI:**
|
|
6856
7024
|
```bash
|
|
6857
7025
|
agentmail pods:threads list --pod-id <pod_id>
|
|
@@ -6910,6 +7078,82 @@ await client.pods.threads.list("pod_id");
|
|
|
6910
7078
|
</dl>
|
|
6911
7079
|
|
|
6912
7080
|
|
|
7081
|
+
</dd>
|
|
7082
|
+
</dl>
|
|
7083
|
+
</details>
|
|
7084
|
+
|
|
7085
|
+
<details><summary><code>client.pods.threads.<a href="/src/api/resources/pods/resources/threads/client/Client.ts">search</a>(pod_id, { ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
|
|
7086
|
+
<dl>
|
|
7087
|
+
<dd>
|
|
7088
|
+
|
|
7089
|
+
#### 📝 Description
|
|
7090
|
+
|
|
7091
|
+
<dl>
|
|
7092
|
+
<dd>
|
|
7093
|
+
|
|
7094
|
+
<dl>
|
|
7095
|
+
<dd>
|
|
7096
|
+
|
|
7097
|
+
Full-text search across threads in the pod, ranked by relevance. The
|
|
7098
|
+
query is matched against senders, recipients, and subject (substring)
|
|
7099
|
+
and the message body (tokenized full text). Spam, trash, blocked, and
|
|
7100
|
+
unauthenticated threads are always excluded. `limit` cannot exceed 100.
|
|
7101
|
+
</dd>
|
|
7102
|
+
</dl>
|
|
7103
|
+
</dd>
|
|
7104
|
+
</dl>
|
|
7105
|
+
|
|
7106
|
+
#### 🔌 Usage
|
|
7107
|
+
|
|
7108
|
+
<dl>
|
|
7109
|
+
<dd>
|
|
7110
|
+
|
|
7111
|
+
<dl>
|
|
7112
|
+
<dd>
|
|
7113
|
+
|
|
7114
|
+
```typescript
|
|
7115
|
+
await client.pods.threads.search("pod_id", {
|
|
7116
|
+
q: "q"
|
|
7117
|
+
});
|
|
7118
|
+
|
|
7119
|
+
```
|
|
7120
|
+
</dd>
|
|
7121
|
+
</dl>
|
|
7122
|
+
</dd>
|
|
7123
|
+
</dl>
|
|
7124
|
+
|
|
7125
|
+
#### ⚙️ Parameters
|
|
7126
|
+
|
|
7127
|
+
<dl>
|
|
7128
|
+
<dd>
|
|
7129
|
+
|
|
7130
|
+
<dl>
|
|
7131
|
+
<dd>
|
|
7132
|
+
|
|
7133
|
+
**pod_id:** `AgentMail.PodId`
|
|
7134
|
+
|
|
7135
|
+
</dd>
|
|
7136
|
+
</dl>
|
|
7137
|
+
|
|
7138
|
+
<dl>
|
|
7139
|
+
<dd>
|
|
7140
|
+
|
|
7141
|
+
**request:** `AgentMail.pods.SearchThreadsRequest`
|
|
7142
|
+
|
|
7143
|
+
</dd>
|
|
7144
|
+
</dl>
|
|
7145
|
+
|
|
7146
|
+
<dl>
|
|
7147
|
+
<dd>
|
|
7148
|
+
|
|
7149
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7150
|
+
|
|
7151
|
+
</dd>
|
|
7152
|
+
</dl>
|
|
7153
|
+
</dd>
|
|
7154
|
+
</dl>
|
|
7155
|
+
|
|
7156
|
+
|
|
6913
7157
|
</dd>
|
|
6914
7158
|
</dl>
|
|
6915
7159
|
</details>
|
|
@@ -7246,6 +7490,12 @@ await client.pods.threads.delete("pod_id", "thread_id");
|
|
|
7246
7490
|
<dl>
|
|
7247
7491
|
<dd>
|
|
7248
7492
|
|
|
7493
|
+
Lists threads, most recent first. Pass `senders`, `recipients`, or
|
|
7494
|
+
`subject` to filter by substring. Filtered requests are served by
|
|
7495
|
+
search, which caps `limit` at 100. For relevance-ranked full-text
|
|
7496
|
+
search across senders, recipients, subject, and message body, use
|
|
7497
|
+
`Search Threads`.
|
|
7498
|
+
|
|
7249
7499
|
**CLI:**
|
|
7250
7500
|
```bash
|
|
7251
7501
|
agentmail threads list
|
|
@@ -7296,6 +7546,75 @@ await client.threads.list();
|
|
|
7296
7546
|
</dl>
|
|
7297
7547
|
|
|
7298
7548
|
|
|
7549
|
+
</dd>
|
|
7550
|
+
</dl>
|
|
7551
|
+
</details>
|
|
7552
|
+
|
|
7553
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">search</a>({ ...params }) -> AgentMail.SearchThreadsResponse</code></summary>
|
|
7554
|
+
<dl>
|
|
7555
|
+
<dd>
|
|
7556
|
+
|
|
7557
|
+
#### 📝 Description
|
|
7558
|
+
|
|
7559
|
+
<dl>
|
|
7560
|
+
<dd>
|
|
7561
|
+
|
|
7562
|
+
<dl>
|
|
7563
|
+
<dd>
|
|
7564
|
+
|
|
7565
|
+
Full-text search across threads in the organization, ranked by
|
|
7566
|
+
relevance. The query is matched against senders, recipients, and
|
|
7567
|
+
subject (substring) and the message body (tokenized full text). Spam,
|
|
7568
|
+
trash, blocked, and unauthenticated threads are always excluded.
|
|
7569
|
+
`limit` cannot exceed 100.
|
|
7570
|
+
</dd>
|
|
7571
|
+
</dl>
|
|
7572
|
+
</dd>
|
|
7573
|
+
</dl>
|
|
7574
|
+
|
|
7575
|
+
#### 🔌 Usage
|
|
7576
|
+
|
|
7577
|
+
<dl>
|
|
7578
|
+
<dd>
|
|
7579
|
+
|
|
7580
|
+
<dl>
|
|
7581
|
+
<dd>
|
|
7582
|
+
|
|
7583
|
+
```typescript
|
|
7584
|
+
await client.threads.search({
|
|
7585
|
+
q: "q"
|
|
7586
|
+
});
|
|
7587
|
+
|
|
7588
|
+
```
|
|
7589
|
+
</dd>
|
|
7590
|
+
</dl>
|
|
7591
|
+
</dd>
|
|
7592
|
+
</dl>
|
|
7593
|
+
|
|
7594
|
+
#### ⚙️ Parameters
|
|
7595
|
+
|
|
7596
|
+
<dl>
|
|
7597
|
+
<dd>
|
|
7598
|
+
|
|
7599
|
+
<dl>
|
|
7600
|
+
<dd>
|
|
7601
|
+
|
|
7602
|
+
**request:** `AgentMail.SearchThreadsRequest`
|
|
7603
|
+
|
|
7604
|
+
</dd>
|
|
7605
|
+
</dl>
|
|
7606
|
+
|
|
7607
|
+
<dl>
|
|
7608
|
+
<dd>
|
|
7609
|
+
|
|
7610
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
7611
|
+
|
|
7612
|
+
</dd>
|
|
7613
|
+
</dl>
|
|
7614
|
+
</dd>
|
|
7615
|
+
</dl>
|
|
7616
|
+
|
|
7617
|
+
|
|
7299
7618
|
</dd>
|
|
7300
7619
|
</dl>
|
|
7301
7620
|
</details>
|