agentmail 0.4.7 → 0.4.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/apiKeys/types/ApiKey.d.ts +2 -0
- package/dist/cjs/api/resources/apiKeys/types/CreateApiKeyResponse.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/inboxes/client/Client.js +18 -8
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.d.ts +52 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/Client.js +262 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/requests/ListApiKeysRequest.d.ts +9 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/requests/ListApiKeysRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/apiKeys/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/inboxes/resources/index.js +5 -1
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.d.ts +69 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/Client.js +311 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/index.js +17 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/requests/InboxListListEntriesRequest.d.ts +9 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/requests/InboxListListEntriesRequest.js +3 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/resources/lists/index.js +17 -0
- package/dist/cjs/api/resources/lists/types/Direction.d.ts +1 -0
- package/dist/cjs/api/resources/lists/types/Direction.js +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKey.d.ts +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/ApiKey.js +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyResponse.d.ts +1 -0
- package/dist/cjs/serialization/resources/apiKeys/types/CreateApiKeyResponse.js +1 -0
- package/dist/cjs/serialization/resources/lists/types/Direction.d.ts +1 -1
- package/dist/cjs/serialization/resources/lists/types/Direction.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/apiKeys/types/ApiKey.d.mts +2 -0
- package/dist/esm/api/resources/apiKeys/types/CreateApiKeyResponse.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/inboxes/client/Client.mjs +10 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.d.mts +52 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/Client.mjs +225 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/requests/ListApiKeysRequest.d.mts +9 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/requests/ListApiKeysRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/apiKeys/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/inboxes/resources/index.mjs +4 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.d.mts +69 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/Client.mjs +274 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/requests/InboxListListEntriesRequest.d.mts +9 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/requests/InboxListListEntriesRequest.mjs +2 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/lists/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/resources/lists/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/resources/lists/index.mjs +1 -0
- package/dist/esm/api/resources/lists/types/Direction.d.mts +1 -0
- package/dist/esm/api/resources/lists/types/Direction.mjs +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKey.d.mts +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/ApiKey.mjs +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResponse.d.mts +1 -0
- package/dist/esm/serialization/resources/apiKeys/types/CreateApiKeyResponse.mjs +1 -0
- package/dist/esm/serialization/resources/lists/types/Direction.d.mts +1 -1
- package/dist/esm/serialization/resources/lists/types/Direction.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +1365 -57
- package/dist/llms.txt +5 -1
- package/package.json +1 -1
- package/reference.md +469 -0
package/dist/llms.txt
CHANGED
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
- [Join the AgentMail Community](https://docs.agentmail.to/community.mdx): Connect with the AgentMail team and developers, share what you're building, and get support.
|
|
45
45
|
- [Support](https://docs.agentmail.to/support.mdx): Get help with AgentMail through our support channels.
|
|
46
46
|
- [Understanding Email Authentication (SPF, DKIM, DMARC)](https://docs.agentmail.to/email-protocols.mdx): Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.
|
|
47
|
-
- [SOC 2 Compliance](https://docs.agentmail.to/documentation/resources/security-privacy/soc-2-compliance.mdx): AgentMail's SOC 2 Type I
|
|
47
|
+
- [SOC 2 Compliance](https://docs.agentmail.to/documentation/resources/security-privacy/soc-2-compliance.mdx): AgentMail's SOC 2 Type I and Type II compliance.
|
|
48
48
|
- [Spam & Virus Detection](https://docs.agentmail.to/spam-virus-detection.mdx): How AgentMail automatically scans incoming emails for spam and viruses.
|
|
49
49
|
- [API Welcome](https://docs.agentmail.to/api-reference.mdx): Quick overview of the AgentMail SDK
|
|
50
50
|
- [Knowledge Base](https://docs.agentmail.to/knowledge-base.mdx): A collection of answers to frequently asked questions.
|
|
@@ -100,6 +100,10 @@
|
|
|
100
100
|
- API Reference > Inboxes > Drafts [Update Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/update.mdx)
|
|
101
101
|
- API Reference > Inboxes > Drafts [Delete Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/delete.mdx)
|
|
102
102
|
- API Reference > Inboxes > Drafts [Send Draft](https://docs.agentmail.to/api-reference/inboxes/drafts/send.mdx)
|
|
103
|
+
- API Reference > Inboxes > Lists [List Entries](https://docs.agentmail.to/api-reference/inboxes/lists/list.mdx)
|
|
104
|
+
- API Reference > Inboxes > Lists [Get List Entry](https://docs.agentmail.to/api-reference/inboxes/lists/get.mdx)
|
|
105
|
+
- API Reference > Inboxes > Lists [Create List Entry](https://docs.agentmail.to/api-reference/inboxes/lists/create.mdx)
|
|
106
|
+
- API Reference > Inboxes > Lists [Delete List Entry](https://docs.agentmail.to/api-reference/inboxes/lists/delete.mdx)
|
|
103
107
|
- API Reference > Inboxes > Metrics [Query Metrics](https://docs.agentmail.to/api-reference/inboxes/metrics/query.mdx)
|
|
104
108
|
- API Reference > Threads [List Threads](https://docs.agentmail.to/api-reference/threads/list.mdx)
|
|
105
109
|
- API Reference > Threads [Get Thread](https://docs.agentmail.to/api-reference/threads/get.mdx)
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -1366,6 +1366,180 @@ await client.drafts.getAttachment("draft_id", "attachment_id");
|
|
|
1366
1366
|
</dl>
|
|
1367
1367
|
|
|
1368
1368
|
|
|
1369
|
+
</dd>
|
|
1370
|
+
</dl>
|
|
1371
|
+
</details>
|
|
1372
|
+
|
|
1373
|
+
## Inboxes ApiKeys
|
|
1374
|
+
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">list</a>(inbox_id, { ...params }) -> AgentMail.ListApiKeysResponse</code></summary>
|
|
1375
|
+
<dl>
|
|
1376
|
+
<dd>
|
|
1377
|
+
|
|
1378
|
+
#### 🔌 Usage
|
|
1379
|
+
|
|
1380
|
+
<dl>
|
|
1381
|
+
<dd>
|
|
1382
|
+
|
|
1383
|
+
<dl>
|
|
1384
|
+
<dd>
|
|
1385
|
+
|
|
1386
|
+
```typescript
|
|
1387
|
+
await client.inboxes.apiKeys.list("inbox_id");
|
|
1388
|
+
|
|
1389
|
+
```
|
|
1390
|
+
</dd>
|
|
1391
|
+
</dl>
|
|
1392
|
+
</dd>
|
|
1393
|
+
</dl>
|
|
1394
|
+
|
|
1395
|
+
#### ⚙️ Parameters
|
|
1396
|
+
|
|
1397
|
+
<dl>
|
|
1398
|
+
<dd>
|
|
1399
|
+
|
|
1400
|
+
<dl>
|
|
1401
|
+
<dd>
|
|
1402
|
+
|
|
1403
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
1404
|
+
|
|
1405
|
+
</dd>
|
|
1406
|
+
</dl>
|
|
1407
|
+
|
|
1408
|
+
<dl>
|
|
1409
|
+
<dd>
|
|
1410
|
+
|
|
1411
|
+
**request:** `AgentMail.inboxes.ListApiKeysRequest`
|
|
1412
|
+
|
|
1413
|
+
</dd>
|
|
1414
|
+
</dl>
|
|
1415
|
+
|
|
1416
|
+
<dl>
|
|
1417
|
+
<dd>
|
|
1418
|
+
|
|
1419
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1420
|
+
|
|
1421
|
+
</dd>
|
|
1422
|
+
</dl>
|
|
1423
|
+
</dd>
|
|
1424
|
+
</dl>
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
</dd>
|
|
1428
|
+
</dl>
|
|
1429
|
+
</details>
|
|
1430
|
+
|
|
1431
|
+
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">create</a>(inbox_id, { ...params }) -> AgentMail.CreateApiKeyResponse</code></summary>
|
|
1432
|
+
<dl>
|
|
1433
|
+
<dd>
|
|
1434
|
+
|
|
1435
|
+
#### 🔌 Usage
|
|
1436
|
+
|
|
1437
|
+
<dl>
|
|
1438
|
+
<dd>
|
|
1439
|
+
|
|
1440
|
+
<dl>
|
|
1441
|
+
<dd>
|
|
1442
|
+
|
|
1443
|
+
```typescript
|
|
1444
|
+
await client.inboxes.apiKeys.create("inbox_id", {
|
|
1445
|
+
name: "name"
|
|
1446
|
+
});
|
|
1447
|
+
|
|
1448
|
+
```
|
|
1449
|
+
</dd>
|
|
1450
|
+
</dl>
|
|
1451
|
+
</dd>
|
|
1452
|
+
</dl>
|
|
1453
|
+
|
|
1454
|
+
#### ⚙️ Parameters
|
|
1455
|
+
|
|
1456
|
+
<dl>
|
|
1457
|
+
<dd>
|
|
1458
|
+
|
|
1459
|
+
<dl>
|
|
1460
|
+
<dd>
|
|
1461
|
+
|
|
1462
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
1463
|
+
|
|
1464
|
+
</dd>
|
|
1465
|
+
</dl>
|
|
1466
|
+
|
|
1467
|
+
<dl>
|
|
1468
|
+
<dd>
|
|
1469
|
+
|
|
1470
|
+
**request:** `AgentMail.CreateApiKeyRequest`
|
|
1471
|
+
|
|
1472
|
+
</dd>
|
|
1473
|
+
</dl>
|
|
1474
|
+
|
|
1475
|
+
<dl>
|
|
1476
|
+
<dd>
|
|
1477
|
+
|
|
1478
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1479
|
+
|
|
1480
|
+
</dd>
|
|
1481
|
+
</dl>
|
|
1482
|
+
</dd>
|
|
1483
|
+
</dl>
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
</dd>
|
|
1487
|
+
</dl>
|
|
1488
|
+
</details>
|
|
1489
|
+
|
|
1490
|
+
<details><summary><code>client.inboxes.apiKeys.<a href="/src/api/resources/inboxes/resources/apiKeys/client/Client.ts">delete</a>(inbox_id, api_key) -> void</code></summary>
|
|
1491
|
+
<dl>
|
|
1492
|
+
<dd>
|
|
1493
|
+
|
|
1494
|
+
#### 🔌 Usage
|
|
1495
|
+
|
|
1496
|
+
<dl>
|
|
1497
|
+
<dd>
|
|
1498
|
+
|
|
1499
|
+
<dl>
|
|
1500
|
+
<dd>
|
|
1501
|
+
|
|
1502
|
+
```typescript
|
|
1503
|
+
await client.inboxes.apiKeys.delete("inbox_id", "api_key");
|
|
1504
|
+
|
|
1505
|
+
```
|
|
1506
|
+
</dd>
|
|
1507
|
+
</dl>
|
|
1508
|
+
</dd>
|
|
1509
|
+
</dl>
|
|
1510
|
+
|
|
1511
|
+
#### ⚙️ Parameters
|
|
1512
|
+
|
|
1513
|
+
<dl>
|
|
1514
|
+
<dd>
|
|
1515
|
+
|
|
1516
|
+
<dl>
|
|
1517
|
+
<dd>
|
|
1518
|
+
|
|
1519
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
1520
|
+
|
|
1521
|
+
</dd>
|
|
1522
|
+
</dl>
|
|
1523
|
+
|
|
1524
|
+
<dl>
|
|
1525
|
+
<dd>
|
|
1526
|
+
|
|
1527
|
+
**api_key:** `AgentMail.ApiKeyId`
|
|
1528
|
+
|
|
1529
|
+
</dd>
|
|
1530
|
+
</dl>
|
|
1531
|
+
|
|
1532
|
+
<dl>
|
|
1533
|
+
<dd>
|
|
1534
|
+
|
|
1535
|
+
**requestOptions:** `ApiKeysClient.RequestOptions`
|
|
1536
|
+
|
|
1537
|
+
</dd>
|
|
1538
|
+
</dl>
|
|
1539
|
+
</dd>
|
|
1540
|
+
</dl>
|
|
1541
|
+
|
|
1542
|
+
|
|
1369
1543
|
</dd>
|
|
1370
1544
|
</dl>
|
|
1371
1545
|
</details>
|
|
@@ -1790,6 +1964,301 @@ await client.inboxes.drafts.send("inbox_id", "draft_id", {});
|
|
|
1790
1964
|
</dl>
|
|
1791
1965
|
|
|
1792
1966
|
|
|
1967
|
+
</dd>
|
|
1968
|
+
</dl>
|
|
1969
|
+
</details>
|
|
1970
|
+
|
|
1971
|
+
## Inboxes Lists
|
|
1972
|
+
<details><summary><code>client.inboxes.lists.<a href="/src/api/resources/inboxes/resources/lists/client/Client.ts">list</a>(inbox_id, direction, type, { ...params }) -> AgentMail.PodListListEntriesResponse</code></summary>
|
|
1973
|
+
<dl>
|
|
1974
|
+
<dd>
|
|
1975
|
+
|
|
1976
|
+
#### 🔌 Usage
|
|
1977
|
+
|
|
1978
|
+
<dl>
|
|
1979
|
+
<dd>
|
|
1980
|
+
|
|
1981
|
+
<dl>
|
|
1982
|
+
<dd>
|
|
1983
|
+
|
|
1984
|
+
```typescript
|
|
1985
|
+
await client.inboxes.lists.list("inbox_id", "send", "allow");
|
|
1986
|
+
|
|
1987
|
+
```
|
|
1988
|
+
</dd>
|
|
1989
|
+
</dl>
|
|
1990
|
+
</dd>
|
|
1991
|
+
</dl>
|
|
1992
|
+
|
|
1993
|
+
#### ⚙️ Parameters
|
|
1994
|
+
|
|
1995
|
+
<dl>
|
|
1996
|
+
<dd>
|
|
1997
|
+
|
|
1998
|
+
<dl>
|
|
1999
|
+
<dd>
|
|
2000
|
+
|
|
2001
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2002
|
+
|
|
2003
|
+
</dd>
|
|
2004
|
+
</dl>
|
|
2005
|
+
|
|
2006
|
+
<dl>
|
|
2007
|
+
<dd>
|
|
2008
|
+
|
|
2009
|
+
**direction:** `AgentMail.Direction`
|
|
2010
|
+
|
|
2011
|
+
</dd>
|
|
2012
|
+
</dl>
|
|
2013
|
+
|
|
2014
|
+
<dl>
|
|
2015
|
+
<dd>
|
|
2016
|
+
|
|
2017
|
+
**type:** `AgentMail.ListType`
|
|
2018
|
+
|
|
2019
|
+
</dd>
|
|
2020
|
+
</dl>
|
|
2021
|
+
|
|
2022
|
+
<dl>
|
|
2023
|
+
<dd>
|
|
2024
|
+
|
|
2025
|
+
**request:** `AgentMail.inboxes.InboxListListEntriesRequest`
|
|
2026
|
+
|
|
2027
|
+
</dd>
|
|
2028
|
+
</dl>
|
|
2029
|
+
|
|
2030
|
+
<dl>
|
|
2031
|
+
<dd>
|
|
2032
|
+
|
|
2033
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
2034
|
+
|
|
2035
|
+
</dd>
|
|
2036
|
+
</dl>
|
|
2037
|
+
</dd>
|
|
2038
|
+
</dl>
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
</dd>
|
|
2042
|
+
</dl>
|
|
2043
|
+
</details>
|
|
2044
|
+
|
|
2045
|
+
<details><summary><code>client.inboxes.lists.<a href="/src/api/resources/inboxes/resources/lists/client/Client.ts">get</a>(inbox_id, direction, type, entry) -> AgentMail.PodListEntry</code></summary>
|
|
2046
|
+
<dl>
|
|
2047
|
+
<dd>
|
|
2048
|
+
|
|
2049
|
+
#### 🔌 Usage
|
|
2050
|
+
|
|
2051
|
+
<dl>
|
|
2052
|
+
<dd>
|
|
2053
|
+
|
|
2054
|
+
<dl>
|
|
2055
|
+
<dd>
|
|
2056
|
+
|
|
2057
|
+
```typescript
|
|
2058
|
+
await client.inboxes.lists.get("inbox_id", "send", "allow", "entry");
|
|
2059
|
+
|
|
2060
|
+
```
|
|
2061
|
+
</dd>
|
|
2062
|
+
</dl>
|
|
2063
|
+
</dd>
|
|
2064
|
+
</dl>
|
|
2065
|
+
|
|
2066
|
+
#### ⚙️ Parameters
|
|
2067
|
+
|
|
2068
|
+
<dl>
|
|
2069
|
+
<dd>
|
|
2070
|
+
|
|
2071
|
+
<dl>
|
|
2072
|
+
<dd>
|
|
2073
|
+
|
|
2074
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2075
|
+
|
|
2076
|
+
</dd>
|
|
2077
|
+
</dl>
|
|
2078
|
+
|
|
2079
|
+
<dl>
|
|
2080
|
+
<dd>
|
|
2081
|
+
|
|
2082
|
+
**direction:** `AgentMail.Direction`
|
|
2083
|
+
|
|
2084
|
+
</dd>
|
|
2085
|
+
</dl>
|
|
2086
|
+
|
|
2087
|
+
<dl>
|
|
2088
|
+
<dd>
|
|
2089
|
+
|
|
2090
|
+
**type:** `AgentMail.ListType`
|
|
2091
|
+
|
|
2092
|
+
</dd>
|
|
2093
|
+
</dl>
|
|
2094
|
+
|
|
2095
|
+
<dl>
|
|
2096
|
+
<dd>
|
|
2097
|
+
|
|
2098
|
+
**entry:** `string` — Email address or domain.
|
|
2099
|
+
|
|
2100
|
+
</dd>
|
|
2101
|
+
</dl>
|
|
2102
|
+
|
|
2103
|
+
<dl>
|
|
2104
|
+
<dd>
|
|
2105
|
+
|
|
2106
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
2107
|
+
|
|
2108
|
+
</dd>
|
|
2109
|
+
</dl>
|
|
2110
|
+
</dd>
|
|
2111
|
+
</dl>
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
</dd>
|
|
2115
|
+
</dl>
|
|
2116
|
+
</details>
|
|
2117
|
+
|
|
2118
|
+
<details><summary><code>client.inboxes.lists.<a href="/src/api/resources/inboxes/resources/lists/client/Client.ts">create</a>(inbox_id, direction, type, { ...params }) -> AgentMail.PodListEntry</code></summary>
|
|
2119
|
+
<dl>
|
|
2120
|
+
<dd>
|
|
2121
|
+
|
|
2122
|
+
#### 🔌 Usage
|
|
2123
|
+
|
|
2124
|
+
<dl>
|
|
2125
|
+
<dd>
|
|
2126
|
+
|
|
2127
|
+
<dl>
|
|
2128
|
+
<dd>
|
|
2129
|
+
|
|
2130
|
+
```typescript
|
|
2131
|
+
await client.inboxes.lists.create("inbox_id", "send", "allow", {
|
|
2132
|
+
entry: "entry"
|
|
2133
|
+
});
|
|
2134
|
+
|
|
2135
|
+
```
|
|
2136
|
+
</dd>
|
|
2137
|
+
</dl>
|
|
2138
|
+
</dd>
|
|
2139
|
+
</dl>
|
|
2140
|
+
|
|
2141
|
+
#### ⚙️ Parameters
|
|
2142
|
+
|
|
2143
|
+
<dl>
|
|
2144
|
+
<dd>
|
|
2145
|
+
|
|
2146
|
+
<dl>
|
|
2147
|
+
<dd>
|
|
2148
|
+
|
|
2149
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2150
|
+
|
|
2151
|
+
</dd>
|
|
2152
|
+
</dl>
|
|
2153
|
+
|
|
2154
|
+
<dl>
|
|
2155
|
+
<dd>
|
|
2156
|
+
|
|
2157
|
+
**direction:** `AgentMail.Direction`
|
|
2158
|
+
|
|
2159
|
+
</dd>
|
|
2160
|
+
</dl>
|
|
2161
|
+
|
|
2162
|
+
<dl>
|
|
2163
|
+
<dd>
|
|
2164
|
+
|
|
2165
|
+
**type:** `AgentMail.ListType`
|
|
2166
|
+
|
|
2167
|
+
</dd>
|
|
2168
|
+
</dl>
|
|
2169
|
+
|
|
2170
|
+
<dl>
|
|
2171
|
+
<dd>
|
|
2172
|
+
|
|
2173
|
+
**request:** `AgentMail.CreateListEntryRequest`
|
|
2174
|
+
|
|
2175
|
+
</dd>
|
|
2176
|
+
</dl>
|
|
2177
|
+
|
|
2178
|
+
<dl>
|
|
2179
|
+
<dd>
|
|
2180
|
+
|
|
2181
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
2182
|
+
|
|
2183
|
+
</dd>
|
|
2184
|
+
</dl>
|
|
2185
|
+
</dd>
|
|
2186
|
+
</dl>
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
</dd>
|
|
2190
|
+
</dl>
|
|
2191
|
+
</details>
|
|
2192
|
+
|
|
2193
|
+
<details><summary><code>client.inboxes.lists.<a href="/src/api/resources/inboxes/resources/lists/client/Client.ts">delete</a>(inbox_id, direction, type, entry) -> void</code></summary>
|
|
2194
|
+
<dl>
|
|
2195
|
+
<dd>
|
|
2196
|
+
|
|
2197
|
+
#### 🔌 Usage
|
|
2198
|
+
|
|
2199
|
+
<dl>
|
|
2200
|
+
<dd>
|
|
2201
|
+
|
|
2202
|
+
<dl>
|
|
2203
|
+
<dd>
|
|
2204
|
+
|
|
2205
|
+
```typescript
|
|
2206
|
+
await client.inboxes.lists.delete("inbox_id", "send", "allow", "entry");
|
|
2207
|
+
|
|
2208
|
+
```
|
|
2209
|
+
</dd>
|
|
2210
|
+
</dl>
|
|
2211
|
+
</dd>
|
|
2212
|
+
</dl>
|
|
2213
|
+
|
|
2214
|
+
#### ⚙️ Parameters
|
|
2215
|
+
|
|
2216
|
+
<dl>
|
|
2217
|
+
<dd>
|
|
2218
|
+
|
|
2219
|
+
<dl>
|
|
2220
|
+
<dd>
|
|
2221
|
+
|
|
2222
|
+
**inbox_id:** `AgentMail.InboxId`
|
|
2223
|
+
|
|
2224
|
+
</dd>
|
|
2225
|
+
</dl>
|
|
2226
|
+
|
|
2227
|
+
<dl>
|
|
2228
|
+
<dd>
|
|
2229
|
+
|
|
2230
|
+
**direction:** `AgentMail.Direction`
|
|
2231
|
+
|
|
2232
|
+
</dd>
|
|
2233
|
+
</dl>
|
|
2234
|
+
|
|
2235
|
+
<dl>
|
|
2236
|
+
<dd>
|
|
2237
|
+
|
|
2238
|
+
**type:** `AgentMail.ListType`
|
|
2239
|
+
|
|
2240
|
+
</dd>
|
|
2241
|
+
</dl>
|
|
2242
|
+
|
|
2243
|
+
<dl>
|
|
2244
|
+
<dd>
|
|
2245
|
+
|
|
2246
|
+
**entry:** `string` — Email address or domain.
|
|
2247
|
+
|
|
2248
|
+
</dd>
|
|
2249
|
+
</dl>
|
|
2250
|
+
|
|
2251
|
+
<dl>
|
|
2252
|
+
<dd>
|
|
2253
|
+
|
|
2254
|
+
**requestOptions:** `ListsClient.RequestOptions`
|
|
2255
|
+
|
|
2256
|
+
</dd>
|
|
2257
|
+
</dl>
|
|
2258
|
+
</dd>
|
|
2259
|
+
</dl>
|
|
2260
|
+
|
|
2261
|
+
|
|
1793
2262
|
</dd>
|
|
1794
2263
|
</dl>
|
|
1795
2264
|
</details>
|