agentmail 0.4.19 → 0.5.0
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/events/types/EventType.d.ts +1 -0
- package/dist/cjs/api/resources/events/types/EventType.js +1 -0
- package/dist/cjs/api/resources/events/types/MessageReceivedEvent.d.ts +4 -1
- package/dist/cjs/api/resources/events/types/MessageReceivedEventType.d.ts +7 -0
- package/dist/cjs/api/resources/events/types/MessageReceivedEventType.js +10 -0
- package/dist/cjs/api/resources/events/types/index.d.ts +1 -2
- package/dist/cjs/api/resources/events/types/index.js +1 -2
- package/dist/cjs/api/resources/inboxEvents/types/InboxEventType.d.ts +10 -3
- package/dist/cjs/api/resources/inboxEvents/types/InboxEventType.js +10 -3
- package/dist/cjs/api/resources/websockets/client/Socket.d.ts +1 -1
- package/dist/cjs/serialization/resources/events/types/EventType.d.ts +1 -1
- package/dist/cjs/serialization/resources/events/types/EventType.js +1 -0
- package/dist/cjs/serialization/resources/events/types/MessageReceivedEvent.d.ts +2 -1
- package/dist/cjs/serialization/resources/events/types/MessageReceivedEvent.js +2 -1
- package/dist/cjs/serialization/resources/events/types/MessageReceivedEventType.d.ts +7 -0
- package/dist/cjs/serialization/resources/events/types/{MessageReceivedSpamEvent.js → MessageReceivedEventType.js} +7 -11
- package/dist/cjs/serialization/resources/events/types/index.d.ts +1 -2
- package/dist/cjs/serialization/resources/events/types/index.js +1 -2
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventType.d.ts +1 -1
- package/dist/cjs/serialization/resources/inboxEvents/types/InboxEventType.js +1 -1
- package/dist/cjs/serialization/resources/websockets/client/socket/WebsocketsSocketResponse.d.ts +2 -4
- package/dist/cjs/serialization/resources/websockets/client/socket/WebsocketsSocketResponse.js +0 -4
- 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/events/types/EventType.d.mts +1 -0
- package/dist/esm/api/resources/events/types/EventType.mjs +1 -0
- package/dist/esm/api/resources/events/types/MessageReceivedEvent.d.mts +4 -1
- package/dist/esm/api/resources/events/types/MessageReceivedEventType.d.mts +7 -0
- package/dist/esm/api/resources/events/types/MessageReceivedEventType.mjs +7 -0
- package/dist/esm/api/resources/events/types/index.d.mts +1 -2
- package/dist/esm/api/resources/events/types/index.mjs +1 -2
- package/dist/esm/api/resources/inboxEvents/types/InboxEventType.d.mts +10 -3
- package/dist/esm/api/resources/inboxEvents/types/InboxEventType.mjs +10 -3
- package/dist/esm/api/resources/websockets/client/Socket.d.mts +1 -1
- package/dist/esm/serialization/resources/events/types/EventType.d.mts +1 -1
- package/dist/esm/serialization/resources/events/types/EventType.mjs +1 -0
- package/dist/esm/serialization/resources/events/types/MessageReceivedEvent.d.mts +2 -1
- package/dist/esm/serialization/resources/events/types/MessageReceivedEvent.mjs +2 -1
- package/dist/esm/serialization/resources/events/types/MessageReceivedEventType.d.mts +7 -0
- package/dist/esm/serialization/resources/events/types/MessageReceivedEventType.mjs +8 -0
- package/dist/esm/serialization/resources/events/types/index.d.mts +1 -2
- package/dist/esm/serialization/resources/events/types/index.mjs +1 -2
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEventType.d.mts +1 -1
- package/dist/esm/serialization/resources/inboxEvents/types/InboxEventType.mjs +1 -1
- package/dist/esm/serialization/resources/websockets/client/socket/WebsocketsSocketResponse.d.mts +2 -4
- package/dist/esm/serialization/resources/websockets/client/socket/WebsocketsSocketResponse.mjs +0 -4
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms-full.txt +683 -1055
- package/dist/llms.txt +4 -0
- package/package.json +1 -1
- package/dist/cjs/api/resources/events/types/MessageReceivedBlockedEvent.d.ts +0 -11
- package/dist/cjs/api/resources/events/types/MessageReceivedBlockedEvent.js +0 -3
- package/dist/cjs/api/resources/events/types/MessageReceivedSpamEvent.d.ts +0 -11
- package/dist/cjs/api/resources/events/types/MessageReceivedSpamEvent.js +0 -3
- package/dist/cjs/serialization/resources/events/types/MessageReceivedBlockedEvent.d.ts +0 -16
- package/dist/cjs/serialization/resources/events/types/MessageReceivedBlockedEvent.js +0 -48
- package/dist/cjs/serialization/resources/events/types/MessageReceivedSpamEvent.d.ts +0 -16
- package/dist/esm/api/resources/events/types/MessageReceivedBlockedEvent.d.mts +0 -11
- package/dist/esm/api/resources/events/types/MessageReceivedBlockedEvent.mjs +0 -2
- package/dist/esm/api/resources/events/types/MessageReceivedSpamEvent.d.mts +0 -11
- package/dist/esm/api/resources/events/types/MessageReceivedSpamEvent.mjs +0 -2
- package/dist/esm/serialization/resources/events/types/MessageReceivedBlockedEvent.d.mts +0 -16
- package/dist/esm/serialization/resources/events/types/MessageReceivedBlockedEvent.mjs +0 -12
- package/dist/esm/serialization/resources/events/types/MessageReceivedSpamEvent.d.mts +0 -16
- package/dist/esm/serialization/resources/events/types/MessageReceivedSpamEvent.mjs +0 -12
package/dist/llms-full.txt
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
# AgentMail | Documentation
|
|
2
|
+
|
|
3
|
+
> AgentMail is an email API built for AI agents. Create inboxes, send and receive messages, manage threads, and handle webhooks programmatically.
|
|
2
4
|
|
|
3
|
-
|
|
4
|
-
slug: welcome
|
|
5
|
-
description: Your starting point for building with the AgentMail API.
|
|
6
|
-
---------------------
|
|
5
|
+
# Welcome
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
> Your starting point for building with the AgentMail API.
|
|
9
8
|
|
|
10
9
|
<Tip title="Welcome to AgentMail!" icon="fa-solid fa-star">
|
|
11
10
|
We're thrilled to have you here! Dive in to learn how to give your AI agents their own email inboxes.
|
|
@@ -45,14 +44,7 @@ AgentMail is an API platform for giving AI agents their own inboxes to send, rec
|
|
|
45
44
|
</Card>
|
|
46
45
|
</CardGroup>
|
|
47
46
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
title: Introduction
|
|
51
|
-
subtitle: Give AI agents email inboxes
|
|
52
|
-
slug: introduction
|
|
53
|
-
---------------------
|
|
54
|
-
|
|
55
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47
|
+
# Introduction
|
|
56
48
|
|
|
57
49
|
## What is AgentMail?
|
|
58
50
|
|
|
@@ -169,278 +161,106 @@ Our customers use AgentMail for agent identity, authentication, and communicatio
|
|
|
169
161
|
<Card title="Email" icon="fa-solid fa-envelope" href="mailto:support@agentmail.cc" />
|
|
170
162
|
</CardGroup>
|
|
171
163
|
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
title: Quickstart
|
|
175
|
-
subtitle: Create your first inbox with the AgentMail API
|
|
176
|
-
slug: quickstart
|
|
177
|
-
description: Follow this guide to make your first AgentMail API request and create a new email inbox.
|
|
178
|
-
---------------------
|
|
179
|
-
|
|
180
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
181
|
-
|
|
182
|
-
## Quickest start
|
|
183
|
-
|
|
184
|
-
<CodeBlocks>
|
|
185
|
-
```bash title="Python"
|
|
186
|
-
pip install agentmail
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
```bash title="TypeScript"
|
|
190
|
-
npm install agentmail
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
```bash title="CLI"
|
|
194
|
-
npm install -g agentmail-cli
|
|
195
|
-
```
|
|
196
|
-
</CodeBlocks>
|
|
197
|
-
|
|
198
|
-
Sign up your agent and get an API key in one call (no console needed):
|
|
199
|
-
|
|
200
|
-
<CodeBlocks>
|
|
201
|
-
```python title="Python"
|
|
202
|
-
from agentmail import AgentMail
|
|
203
|
-
|
|
204
|
-
client = AgentMail()
|
|
205
|
-
response = client.agent.sign_up(human_email="you@example.com", username="my-agent")
|
|
206
|
-
# response.api_key -> store this securely
|
|
207
|
-
# response.inbox_id -> my-agent@agentmail.to
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
```typescript title="TypeScript"
|
|
211
|
-
import { AgentMailClient } from "agentmail";
|
|
212
|
-
|
|
213
|
-
const client = new AgentMailClient();
|
|
214
|
-
const response = await client.agent.signUp({ humanEmail: "you@example.com", username: "my-agent" });
|
|
215
|
-
// response.apiKey -> store this securely
|
|
216
|
-
// response.inboxId -> my-agent@agentmail.to
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
```bash title="CLI"
|
|
220
|
-
agentmail agent sign-up --human-email you@example.com --username my-agent
|
|
221
|
-
```
|
|
222
|
-
</CodeBlocks>
|
|
223
|
-
|
|
224
|
-
Verify with the OTP sent to your email, then send a message:
|
|
225
|
-
|
|
226
|
-
<CodeBlocks>
|
|
227
|
-
```python title="Python"
|
|
228
|
-
client = AgentMail(api_key="am_...")
|
|
229
|
-
client.agent.verify(otp_code="123456")
|
|
230
|
-
|
|
231
|
-
inbox = client.inboxes.create()
|
|
232
|
-
client.inboxes.messages.send(inbox.inbox_id, to="user@example.com", subject="Hello", text="Hello from my agent!")
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
```typescript title="TypeScript"
|
|
236
|
-
import { AgentMailClient } from "agentmail";
|
|
237
|
-
|
|
238
|
-
const client = new AgentMailClient({ apiKey: "am_..." });
|
|
239
|
-
await client.agent.verify({ otpCode: "123456" });
|
|
240
|
-
|
|
241
|
-
const inbox = await client.inboxes.create();
|
|
242
|
-
await client.inboxes.messages.send(inbox.inboxId, { to: "user@example.com", subject: "Hello", text: "Hello from my agent!" });
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
```bash title="CLI"
|
|
246
|
-
agentmail agent verify --otp-code 123456
|
|
247
|
-
|
|
248
|
-
# create an inbox
|
|
249
|
-
agentmail inboxes create
|
|
250
|
-
|
|
251
|
-
# send an email (replace <inbox_id> with the id from above)
|
|
252
|
-
agentmail inboxes:messages send \
|
|
253
|
-
--inbox-id <inbox_id> \
|
|
254
|
-
--to user@example.com \
|
|
255
|
-
--subject "Hello" \
|
|
256
|
-
--text "Hello from my agent!"
|
|
257
|
-
```
|
|
258
|
-
</CodeBlocks>
|
|
259
|
-
|
|
260
|
-
<Note>
|
|
261
|
-
Already have an account? Get your API key from the [Console](https://console.agentmail.to) and skip straight to sending emails.
|
|
262
|
-
</Note>
|
|
263
|
-
|
|
264
|
-
## Copy for Cursor / Claude
|
|
265
|
-
|
|
266
|
-
Copy one of the blocks below into Cursor or Claude for a complete, working AgentMail integration. Each block includes setup, API reference, error handling, rate limiting, and idempotency guidance.
|
|
267
|
-
|
|
268
|
-
<CodeBlocks>
|
|
269
|
-
```python title="Python"
|
|
270
|
-
"""
|
|
271
|
-
AgentMail Python Quickstart — copy into Cursor/Claude for instant setup.
|
|
272
|
-
|
|
273
|
-
Setup: pip install agentmail python-dotenv. Set AGENTMAIL_API_KEY in .env.
|
|
274
|
-
|
|
275
|
-
Agent sign-up (no API key needed):
|
|
276
|
-
- agent.sign_up(human_email, username) — returns api_key, inbox_id, organization_id
|
|
277
|
-
- agent.verify(otp_code) — verify with OTP sent to human_email
|
|
164
|
+
# Quickstart
|
|
278
165
|
|
|
279
|
-
|
|
280
|
-
- inboxes.create(username?, domain?, display_name?, client_id?) — client_id for idempotent retries
|
|
281
|
-
- messages.send(inbox_id, to, subject, text, html?, cc?, bcc?, reply_to?, attachments?)
|
|
282
|
-
- messages.list(inbox_id, limit?, page_token?, labels?) — receive emails; use extracted_text/extracted_html for reply content
|
|
283
|
-
|
|
284
|
-
Errors: SDK raises on 4xx/5xx. Inspect error.body.message or str(e).
|
|
285
|
-
Rate limit: 429 with Retry-After header. Implement exponential backoff for retries.
|
|
286
|
-
Idempotency: Pass client_id to inboxes.create() to safely retry without duplicates.
|
|
287
|
-
"""
|
|
288
|
-
import os
|
|
289
|
-
from dotenv import load_dotenv
|
|
290
|
-
from agentmail import AgentMail
|
|
166
|
+
> Follow this guide to make your first AgentMail API request and create a new email inbox.
|
|
291
167
|
|
|
292
|
-
|
|
293
|
-
client = AgentMail(api_key=os.getenv("AGENTMAIL_API_KEY"))
|
|
168
|
+
## For Agents
|
|
294
169
|
|
|
295
|
-
|
|
296
|
-
inbox = client.inboxes.create(client_id="my-agent-inbox-v1")
|
|
170
|
+
For agents that sign themselves up programmatically, no Console or dashboard needed. The agent registers itself using an email you provide and receives an API key in response. This flow is for first-time users only: human email addresses already signed up with AgentMail will not work here.
|
|
297
171
|
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
inbox.inbox_id,
|
|
302
|
-
to="recipient@example.com",
|
|
303
|
-
subject="Hello from AgentMail",
|
|
304
|
-
text="Plain text body",
|
|
305
|
-
html="<p>HTML body</p>",
|
|
306
|
-
)
|
|
307
|
-
except Exception as e:
|
|
308
|
-
# Handle validation, not found, rate limit (429), etc.
|
|
309
|
-
print(f"Send failed: {e}")
|
|
310
|
-
raise
|
|
311
|
-
|
|
312
|
-
# Receive messages
|
|
313
|
-
for msg in client.inboxes.messages.list(inbox.inbox_id, limit=10).messages:
|
|
314
|
-
print(msg.subject, msg.extracted_text or msg.text)
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
```typescript title="TypeScript"
|
|
318
|
-
/**
|
|
319
|
-
* AgentMail TypeScript Quickstart — copy into Cursor/Claude for instant setup.
|
|
320
|
-
*
|
|
321
|
-
* Setup: npm install agentmail dotenv. Set AGENTMAIL_API_KEY in .env.
|
|
322
|
-
*
|
|
323
|
-
* Agent sign-up (no API key needed):
|
|
324
|
-
* - agent.signUp({ humanEmail, username }) — returns apiKey, inboxId, organizationId
|
|
325
|
-
* - agent.verify({ otpCode }) — verify with OTP sent to humanEmail
|
|
326
|
-
*
|
|
327
|
-
* API reference:
|
|
328
|
-
* - inboxes.create({ username?, domain?, displayName?, clientId? }) — clientId for idempotent retries
|
|
329
|
-
* - messages.send(inboxId, { to, subject, text, html?, cc?, bcc?, replyTo?, attachments? })
|
|
330
|
-
* - messages.list(inboxId, { limit?, pageToken?, labels? }) — receive; use extractedText/extractedHtml for reply content
|
|
331
|
-
*
|
|
332
|
-
* Errors: SDK throws on 4xx/5xx. Check error.body?.message.
|
|
333
|
-
* Rate limit: 429 with Retry-After header. Use exponential backoff for retries.
|
|
334
|
-
* Idempotency: Pass clientId to inboxes.create() to safely retry without duplicates.
|
|
335
|
-
*/
|
|
336
|
-
import { AgentMailClient } from "agentmail";
|
|
337
|
-
import "dotenv/config";
|
|
338
|
-
|
|
339
|
-
const client = new AgentMailClient({
|
|
340
|
-
apiKey: process.env.AGENTMAIL_API_KEY!,
|
|
341
|
-
});
|
|
342
|
-
|
|
343
|
-
async function main() {
|
|
344
|
-
// Create inbox (clientId enables safe retries)
|
|
345
|
-
const inbox = await client.inboxes.create({
|
|
346
|
-
clientId: "my-agent-inbox-v1",
|
|
347
|
-
});
|
|
348
|
-
|
|
349
|
-
try {
|
|
350
|
-
await client.inboxes.messages.send(inbox.inboxId, {
|
|
351
|
-
to: "recipient@example.com",
|
|
352
|
-
subject: "Hello from AgentMail",
|
|
353
|
-
text: "Plain text body",
|
|
354
|
-
html: "<p>HTML body</p>",
|
|
355
|
-
});
|
|
356
|
-
} catch (error: unknown) {
|
|
357
|
-
// Handle validation, not found, rate limit (429), etc.
|
|
358
|
-
const msg = (error as { body?: { message?: string } })?.body?.message ?? String(error);
|
|
359
|
-
throw new Error(`Send failed: ${msg}`);
|
|
360
|
-
}
|
|
361
|
-
|
|
362
|
-
// Receive messages
|
|
363
|
-
const res = await client.inboxes.messages.list(inbox.inboxId, { limit: 10 });
|
|
364
|
-
for (const msg of res.messages) {
|
|
365
|
-
console.log(msg.subject, msg.extractedText ?? msg.text);
|
|
366
|
-
}
|
|
367
|
-
}
|
|
368
|
-
|
|
369
|
-
main();
|
|
370
|
-
```
|
|
371
|
-
</CodeBlocks>
|
|
172
|
+
<Steps>
|
|
173
|
+
<Step title="Sign up">
|
|
174
|
+
The agent registers itself using the human email you provide and gets back an API key, inbox ID, and organization ID. An OTP is sent to that email.
|
|
372
175
|
|
|
373
|
-
<
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
</Tip>
|
|
176
|
+
<CodeBlocks>
|
|
177
|
+
```bash title="CLI"
|
|
178
|
+
npm install -g agentmail-cli
|
|
377
179
|
|
|
378
|
-
|
|
180
|
+
agentmail agent sign-up \
|
|
181
|
+
--human-email you@example.com \
|
|
182
|
+
--username my-agent
|
|
183
|
+
```
|
|
379
184
|
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
185
|
+
```bash title="cURL"
|
|
186
|
+
curl -X POST https://api.agentmail.to/agent/sign-up \
|
|
187
|
+
-H "Content-Type: application/json" \
|
|
188
|
+
-d '{
|
|
189
|
+
"human_email": "you@example.com",
|
|
190
|
+
"username": "my-agent"
|
|
191
|
+
}'
|
|
192
|
+
# returns { api_key, inbox_id, organization_id }
|
|
193
|
+
```
|
|
194
|
+
</CodeBlocks>
|
|
383
195
|
|
|
384
|
-
|
|
196
|
+
<Info>
|
|
197
|
+
The sign-up endpoint is idempotent. Calling it again with the same email rotates the API key and resends the OTP if expired.
|
|
198
|
+
</Info>
|
|
199
|
+
</Step>
|
|
385
200
|
|
|
386
|
-
|
|
201
|
+
<Step title="Verify with the OTP">
|
|
202
|
+
Check the human's email for a 6-digit OTP code and verify to unlock full permissions.
|
|
387
203
|
|
|
388
204
|
<CodeBlocks>
|
|
389
|
-
```
|
|
390
|
-
from
|
|
205
|
+
```bash title="CLI"
|
|
206
|
+
export AGENTMAIL_API_KEY="am_..." # from the sign-up response
|
|
391
207
|
|
|
392
|
-
|
|
393
|
-
response = client.agent.sign_up(
|
|
394
|
-
human_email="you@example.com",
|
|
395
|
-
username="my-agent"
|
|
396
|
-
)
|
|
397
|
-
print(response.api_key) # store this securely
|
|
398
|
-
print(response.inbox_id) # my-agent@agentmail.to
|
|
208
|
+
agentmail agent verify --otp-code 123456
|
|
399
209
|
```
|
|
400
210
|
|
|
401
|
-
```
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
humanEmail: "you@example.com",
|
|
407
|
-
username: "my-agent",
|
|
408
|
-
});
|
|
409
|
-
console.log(response.apiKey); // store this securely
|
|
410
|
-
console.log(response.inboxId); // my-agent@agentmail.to
|
|
411
|
-
```
|
|
412
|
-
|
|
413
|
-
```bash title="CLI"
|
|
414
|
-
agentmail agent sign-up \
|
|
415
|
-
--human-email you@example.com \
|
|
416
|
-
--username my-agent
|
|
211
|
+
```bash title="cURL"
|
|
212
|
+
curl -X POST https://api.agentmail.to/agent/verify \
|
|
213
|
+
-H "Authorization: Bearer $AGENTMAIL_API_KEY" \
|
|
214
|
+
-H "Content-Type: application/json" \
|
|
215
|
+
-d '{ "otp_code": "123456" }'
|
|
417
216
|
```
|
|
418
217
|
</CodeBlocks>
|
|
218
|
+
</Step>
|
|
419
219
|
|
|
420
|
-
|
|
220
|
+
<Step title="Create an inbox and send an email">
|
|
221
|
+
With the API key from sign-up, the agent can create inboxes and send mail on its own.
|
|
421
222
|
|
|
422
223
|
<CodeBlocks>
|
|
423
|
-
```
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
```
|
|
224
|
+
```bash title="CLI"
|
|
225
|
+
# create an inbox
|
|
226
|
+
agentmail inboxes create
|
|
427
227
|
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
228
|
+
# send an email (replace <inbox_id> with the id from above)
|
|
229
|
+
agentmail inboxes:messages send \
|
|
230
|
+
--inbox-id <inbox_id> \
|
|
231
|
+
--to recipient@example.com \
|
|
232
|
+
--subject "Hello" \
|
|
233
|
+
--text "Hello from my agent!"
|
|
431
234
|
```
|
|
432
235
|
|
|
433
|
-
```bash title="
|
|
434
|
-
|
|
236
|
+
```bash title="cURL"
|
|
237
|
+
# create an inbox (client_id enables safe retries)
|
|
238
|
+
curl -X POST https://api.agentmail.to/inboxes \
|
|
239
|
+
-H "Authorization: Bearer $AGENTMAIL_API_KEY" \
|
|
240
|
+
-H "Content-Type: application/json" \
|
|
241
|
+
-d '{ "client_id": "my-agent-inbox-v1" }'
|
|
242
|
+
# returns { inbox_id, ... }
|
|
243
|
+
|
|
244
|
+
# send an email (replace <inbox_id> with the id from above)
|
|
245
|
+
curl -X POST https://api.agentmail.to/inboxes/<inbox_id>/messages/send \
|
|
246
|
+
-H "Authorization: Bearer $AGENTMAIL_API_KEY" \
|
|
247
|
+
-H "Content-Type: application/json" \
|
|
248
|
+
-d '{
|
|
249
|
+
"to": "recipient@example.com",
|
|
250
|
+
"subject": "Hello from AgentMail",
|
|
251
|
+
"text": "Plain text body"
|
|
252
|
+
}'
|
|
435
253
|
```
|
|
436
254
|
</CodeBlocks>
|
|
255
|
+
</Step>
|
|
256
|
+
</Steps>
|
|
437
257
|
|
|
438
|
-
|
|
439
|
-
The sign-up endpoint is idempotent. Calling it again with the same email rotates the API key and resends the OTP if expired.
|
|
440
|
-
</Info>
|
|
258
|
+
## For Humans
|
|
441
259
|
|
|
442
|
-
|
|
260
|
+
For developers who want to try AgentMail from the Console.
|
|
443
261
|
|
|
262
|
+
<Steps>
|
|
263
|
+
<Step title="Sign up and get an API key">
|
|
444
264
|
Go to the [AgentMail Console](https://console.agentmail.to), create an account, and generate an API key from the dashboard.
|
|
445
265
|

|
|
446
266
|
</Step>
|
|
@@ -475,10 +295,9 @@ This guide walks you through signing up, authenticating, and creating your first
|
|
|
475
295
|
</Step>
|
|
476
296
|
|
|
477
297
|
<Step title="Create an inbox and send an email">
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
test email.
|
|
298
|
+
Create a new file (e.g., `quickstart.py` or `quickstart.ts`) and add the
|
|
299
|
+
following code. This script initializes the AgentMail client, creates a new
|
|
300
|
+
inbox, and sends a test email.
|
|
482
301
|
|
|
483
302
|
<CodeBlocks>
|
|
484
303
|
```python title="Python"
|
|
@@ -486,28 +305,26 @@ This guide walks you through signing up, authenticating, and creating your first
|
|
|
486
305
|
from dotenv import load_dotenv
|
|
487
306
|
from agentmail import AgentMail
|
|
488
307
|
|
|
489
|
-
#
|
|
308
|
+
# load the API key from the .env file
|
|
490
309
|
load_dotenv()
|
|
491
310
|
api_key = os.getenv("AGENTMAIL_API_KEY")
|
|
492
311
|
|
|
493
|
-
#
|
|
312
|
+
# initialize the client
|
|
494
313
|
client = AgentMail(api_key=api_key)
|
|
495
314
|
|
|
496
|
-
#
|
|
315
|
+
# create an inbox
|
|
497
316
|
print("Creating inbox...")
|
|
498
317
|
inbox = client.inboxes.create() # domain is optional
|
|
499
318
|
print("Inbox created successfully!")
|
|
500
319
|
print(inbox)
|
|
501
320
|
|
|
502
|
-
#
|
|
503
|
-
|
|
321
|
+
# send an email from the new inbox
|
|
504
322
|
client.inboxes.messages.send(
|
|
505
323
|
inbox.inbox_id,
|
|
506
324
|
to="your-email@example.com",
|
|
507
325
|
subject="Hello from AgentMail!",
|
|
508
326
|
text="This is my first email sent with the AgentMail API.",
|
|
509
327
|
)
|
|
510
|
-
|
|
511
328
|
```
|
|
512
329
|
|
|
513
330
|
```typescript title="TypeScript"
|
|
@@ -515,18 +332,18 @@ This guide walks you through signing up, authenticating, and creating your first
|
|
|
515
332
|
import "dotenv/config"; // loads .env file
|
|
516
333
|
|
|
517
334
|
async function main() {
|
|
518
|
-
//
|
|
335
|
+
// initialize the client
|
|
519
336
|
const client = new AgentMailClient({
|
|
520
337
|
apiKey: process.env.AGENTMAIL_API_KEY,
|
|
521
338
|
});
|
|
522
339
|
|
|
523
|
-
//
|
|
340
|
+
// create an inbox
|
|
524
341
|
console.log("Creating inbox...");
|
|
525
342
|
const inbox = await client.inboxes.create(); // domain is optional
|
|
526
343
|
console.log("Inbox created successfully!");
|
|
527
344
|
console.log(inbox);
|
|
528
345
|
|
|
529
|
-
//
|
|
346
|
+
// send an email from the new inbox
|
|
530
347
|
console.log("Sending email...");
|
|
531
348
|
await client.inboxes.messages.send(inbox.inboxId, {
|
|
532
349
|
to: "your-email@example.com",
|
|
@@ -580,6 +397,120 @@ This guide walks you through signing up, authenticating, and creating your first
|
|
|
580
397
|
</Step>
|
|
581
398
|
</Steps>
|
|
582
399
|
|
|
400
|
+
## Copy for Cursor / Claude
|
|
401
|
+
|
|
402
|
+
Copy one of the blocks below into Cursor or Claude for a complete, working AgentMail integration. Each block includes setup, API reference, error handling, rate limiting, and idempotency guidance.
|
|
403
|
+
|
|
404
|
+
<CodeBlocks>
|
|
405
|
+
```python title="Python"
|
|
406
|
+
"""
|
|
407
|
+
AgentMail Python Quickstart — copy into Cursor/Claude for instant setup.
|
|
408
|
+
|
|
409
|
+
Setup: pip install agentmail python-dotenv. Set AGENTMAIL_API_KEY in .env.
|
|
410
|
+
|
|
411
|
+
Agent sign-up (no API key needed):
|
|
412
|
+
- agent.sign_up(human_email, username) — returns api_key, inbox_id, organization_id
|
|
413
|
+
- agent.verify(otp_code) — verify with OTP sent to human_email
|
|
414
|
+
|
|
415
|
+
API reference:
|
|
416
|
+
- inboxes.create(username?, domain?, display_name?, client_id?) — client_id for idempotent retries
|
|
417
|
+
- messages.send(inbox_id, to, subject, text, html?, cc?, bcc?, reply_to?, attachments?)
|
|
418
|
+
- messages.list(inbox_id, limit?, page_token?, labels?) — receive emails; use extracted_text/extracted_html for reply content
|
|
419
|
+
|
|
420
|
+
Errors: SDK raises on 4xx/5xx. Inspect error.body.message or str(e).
|
|
421
|
+
Rate limit: 429 with Retry-After header. Implement exponential backoff for retries.
|
|
422
|
+
Idempotency: Pass client_id to inboxes.create() to safely retry without duplicates.
|
|
423
|
+
"""
|
|
424
|
+
import os
|
|
425
|
+
from dotenv import load_dotenv
|
|
426
|
+
from agentmail import AgentMail
|
|
427
|
+
|
|
428
|
+
load_dotenv()
|
|
429
|
+
client = AgentMail(api_key=os.getenv("AGENTMAIL_API_KEY"))
|
|
430
|
+
|
|
431
|
+
# create inbox (client_id enables safe retries)
|
|
432
|
+
inbox = client.inboxes.create(client_id="my-agent-inbox-v1")
|
|
433
|
+
|
|
434
|
+
# send email
|
|
435
|
+
try:
|
|
436
|
+
client.inboxes.messages.send(
|
|
437
|
+
inbox.inbox_id,
|
|
438
|
+
to="recipient@example.com",
|
|
439
|
+
subject="Hello from AgentMail",
|
|
440
|
+
text="Plain text body",
|
|
441
|
+
html="<p>HTML body</p>",
|
|
442
|
+
)
|
|
443
|
+
except Exception as e:
|
|
444
|
+
# handle validation, not found, rate limit (429), etc.
|
|
445
|
+
print(f"Send failed: {e}")
|
|
446
|
+
raise
|
|
447
|
+
|
|
448
|
+
# receive messages
|
|
449
|
+
for msg in client.inboxes.messages.list(inbox.inbox_id, limit=10).messages:
|
|
450
|
+
print(msg.subject, msg.extracted_text or msg.text)
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
```typescript title="TypeScript"
|
|
454
|
+
/**
|
|
455
|
+
* AgentMail TypeScript Quickstart — copy into Cursor/Claude for instant setup.
|
|
456
|
+
*
|
|
457
|
+
* Setup: npm install agentmail dotenv. Set AGENTMAIL_API_KEY in .env.
|
|
458
|
+
*
|
|
459
|
+
* Agent sign-up (no API key needed):
|
|
460
|
+
* - agent.signUp({ humanEmail, username }) — returns apiKey, inboxId, organizationId
|
|
461
|
+
* - agent.verify({ otpCode }) — verify with OTP sent to humanEmail
|
|
462
|
+
*
|
|
463
|
+
* API reference:
|
|
464
|
+
* - inboxes.create({ username?, domain?, displayName?, clientId? }) — clientId for idempotent retries
|
|
465
|
+
* - messages.send(inboxId, { to, subject, text, html?, cc?, bcc?, replyTo?, attachments? })
|
|
466
|
+
* - messages.list(inboxId, { limit?, pageToken?, labels? }) — receive; use extractedText/extractedHtml for reply content
|
|
467
|
+
*
|
|
468
|
+
* Errors: SDK throws on 4xx/5xx. Check error.body?.message.
|
|
469
|
+
* Rate limit: 429 with Retry-After header. Use exponential backoff for retries.
|
|
470
|
+
* Idempotency: Pass clientId to inboxes.create() to safely retry without duplicates.
|
|
471
|
+
*/
|
|
472
|
+
import { AgentMailClient } from "agentmail";
|
|
473
|
+
import "dotenv/config";
|
|
474
|
+
|
|
475
|
+
const client = new AgentMailClient({
|
|
476
|
+
apiKey: process.env.AGENTMAIL_API_KEY!,
|
|
477
|
+
});
|
|
478
|
+
|
|
479
|
+
async function main() {
|
|
480
|
+
// create inbox (clientId enables safe retries)
|
|
481
|
+
const inbox = await client.inboxes.create({
|
|
482
|
+
clientId: "my-agent-inbox-v1",
|
|
483
|
+
});
|
|
484
|
+
|
|
485
|
+
try {
|
|
486
|
+
await client.inboxes.messages.send(inbox.inboxId, {
|
|
487
|
+
to: "recipient@example.com",
|
|
488
|
+
subject: "Hello from AgentMail",
|
|
489
|
+
text: "Plain text body",
|
|
490
|
+
html: "<p>HTML body</p>",
|
|
491
|
+
});
|
|
492
|
+
} catch (error: unknown) {
|
|
493
|
+
// handle validation, not found, rate limit (429), etc.
|
|
494
|
+
const msg = (error as { body?: { message?: string } })?.body?.message ?? String(error);
|
|
495
|
+
throw new Error(`Send failed: ${msg}`);
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
// receive messages
|
|
499
|
+
const res = await client.inboxes.messages.list(inbox.inboxId, { limit: 10 });
|
|
500
|
+
for (const msg of res.messages) {
|
|
501
|
+
console.log(msg.subject, msg.extractedText ?? msg.text);
|
|
502
|
+
}
|
|
503
|
+
}
|
|
504
|
+
|
|
505
|
+
main();
|
|
506
|
+
```
|
|
507
|
+
</CodeBlocks>
|
|
508
|
+
|
|
509
|
+
<Tip>
|
|
510
|
+
When receiving emails, messages include `extracted_text` and `extracted_html`
|
|
511
|
+
for reply content without quoted history.
|
|
512
|
+
</Tip>
|
|
513
|
+
|
|
583
514
|
## Next Steps
|
|
584
515
|
|
|
585
516
|
You've created an inbox and sent your first email. Now set up your agent to receive and respond to incoming messages:
|
|
@@ -607,15 +538,9 @@ You've created an inbox and sent your first email. Now set up your agent to rece
|
|
|
607
538
|
[support@agentmail.cc](mailto:support@agentmail.cc) and we'll get you set up.
|
|
608
539
|
</Note>
|
|
609
540
|
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
title: Inboxes
|
|
613
|
-
subtitle: The foundation of your agent's identity and communication.
|
|
614
|
-
slug: inboxes
|
|
615
|
-
description: Learn how AgentMail Inboxes act as scalable, API-first email accounts for your agents.
|
|
616
|
-
---------------------
|
|
541
|
+
# Inboxes
|
|
617
542
|
|
|
618
|
-
|
|
543
|
+
> Learn how AgentMail Inboxes act as scalable, API-first email accounts for your agents.
|
|
619
544
|
|
|
620
545
|
## What is an Inbox?
|
|
621
546
|
|
|
@@ -851,15 +776,9 @@ Copy one of the blocks below into Cursor or Claude for complete Inboxes API know
|
|
|
851
776
|
```
|
|
852
777
|
</CodeBlocks>
|
|
853
778
|
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
title: Messages
|
|
857
|
-
subtitle: The fundamental unit of communication for your agents.
|
|
858
|
-
slug: messages
|
|
859
|
-
description: Learn how to send, receive, and manage emails as Message objects with the AgentMail API.
|
|
860
|
-
---------------------
|
|
779
|
+
# Messages
|
|
861
780
|
|
|
862
|
-
|
|
781
|
+
> Learn how to send, receive, and manage emails as Message objects with the AgentMail API.
|
|
863
782
|
|
|
864
783
|
## What is a Message?
|
|
865
784
|
|
|
@@ -1395,15 +1314,9 @@ AgentMail doesn't have a dedicated "mark as read" endpoint — instead, you use
|
|
|
1395
1314
|
```
|
|
1396
1315
|
```
|
|
1397
1316
|
|
|
1398
|
-
|
|
1317
|
+
# Threads
|
|
1399
1318
|
|
|
1400
|
-
|
|
1401
|
-
subtitle: Organizing conversations across your Inboxes.
|
|
1402
|
-
slug: threads
|
|
1403
|
-
description: Learn how AgentMail Threads group messages into conversations and how to query them across your entire organization.
|
|
1404
|
-
---------------------
|
|
1405
|
-
|
|
1406
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
1319
|
+
> Learn how AgentMail Threads group messages into conversations and how to query them across your entire organization.
|
|
1407
1320
|
|
|
1408
1321
|
## What is a Thread?
|
|
1409
1322
|
|
|
@@ -1602,15 +1515,9 @@ Copy one of the blocks below into Cursor or Claude for complete Threads API know
|
|
|
1602
1515
|
```
|
|
1603
1516
|
</CodeBlocks>
|
|
1604
1517
|
|
|
1605
|
-
|
|
1518
|
+
# Drafts
|
|
1606
1519
|
|
|
1607
|
-
|
|
1608
|
-
subtitle: Preparing and scheduling Messages for your agents.
|
|
1609
|
-
slug: drafts
|
|
1610
|
-
description: Learn how to create, manage, and send Drafts to enable advanced agent workflows like human-in-the-loop review and scheduled sending.
|
|
1611
|
-
---------------------
|
|
1612
|
-
|
|
1613
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
1520
|
+
> Learn how to create, manage, and send Drafts to enable advanced agent workflows like human-in-the-loop review and scheduled sending.
|
|
1614
1521
|
|
|
1615
1522
|
## What is a Draft?
|
|
1616
1523
|
|
|
@@ -2158,15 +2065,9 @@ Copy one of the blocks below into Cursor or Claude for complete Drafts API knowl
|
|
|
2158
2065
|
```
|
|
2159
2066
|
</CodeBlocks>
|
|
2160
2067
|
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
title: Labels
|
|
2164
|
-
subtitle: Organizing and categorizing your agent's conversations at scale.
|
|
2165
|
-
slug: labels
|
|
2166
|
-
description: Learn how to use Labels to manage state, track campaigns, and filter messages for powerful agentic workflows.
|
|
2167
|
-
---------------------
|
|
2068
|
+
# Labels
|
|
2168
2069
|
|
|
2169
|
-
|
|
2070
|
+
> Learn how to use Labels to manage state, track campaigns, and filter messages for powerful agentic workflows.
|
|
2170
2071
|
|
|
2171
2072
|
## What are `Labels`?
|
|
2172
2073
|
|
|
@@ -2416,15 +2317,9 @@ Copy one of the blocks below into Cursor or Claude for complete Labels usage in
|
|
|
2416
2317
|
based on their content.
|
|
2417
2318
|
</Callout>
|
|
2418
2319
|
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
|
-
title: Lists
|
|
2422
|
-
subtitle: Filter emails by allowing or blocking specific addresses and domains.
|
|
2423
|
-
slug: lists
|
|
2424
|
-
description: Learn how to use Lists to control which email addresses and domains your agents can send to or receive from.
|
|
2425
|
-
---------------------
|
|
2320
|
+
# Lists
|
|
2426
2321
|
|
|
2427
|
-
|
|
2322
|
+
> Learn how to use Lists to control which email addresses and domains your agents can send to or receive from.
|
|
2428
2323
|
|
|
2429
2324
|
## What are Lists?
|
|
2430
2325
|
|
|
@@ -2724,15 +2619,9 @@ Copy one of the blocks below into Cursor or Claude for complete Lists API knowle
|
|
|
2724
2619
|
```
|
|
2725
2620
|
</CodeBlocks>
|
|
2726
2621
|
|
|
2727
|
-
|
|
2728
|
-
|
|
2729
|
-
title: Attachments
|
|
2730
|
-
subtitle: Sending and receiving files with your agents.
|
|
2731
|
-
slug: attachments
|
|
2732
|
-
description: Learn how to send files as attachments, and download incoming attachments from both messages and threads.
|
|
2733
|
-
---------------------
|
|
2622
|
+
# Attachments
|
|
2734
2623
|
|
|
2735
|
-
|
|
2624
|
+
> Learn how to send files as attachments, and download incoming attachments from both messages and threads.
|
|
2736
2625
|
|
|
2737
2626
|
## What are `Attachments`?
|
|
2738
2627
|
|
|
@@ -2957,13 +2846,9 @@ Copy one of the blocks below into Cursor or Claude for complete Attachments usag
|
|
|
2957
2846
|
```
|
|
2958
2847
|
</CodeBlocks>
|
|
2959
2848
|
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
title: Pods
|
|
2963
|
-
description: Learn how to use pods for multi-tenant email management
|
|
2964
|
-
---------------------
|
|
2849
|
+
# Pods
|
|
2965
2850
|
|
|
2966
|
-
|
|
2851
|
+
> Learn how to use pods for multi-tenant email management
|
|
2967
2852
|
|
|
2968
2853
|
## What are Pods?
|
|
2969
2854
|
|
|
@@ -3254,15 +3139,9 @@ Pod: "Marketing-Agent"
|
|
|
3254
3139
|
* Learn about [Inboxes](/inboxes) and how to create email accounts within pods
|
|
3255
3140
|
* Explore [Domains](/custom-domains) to set up custom email domains for your pods
|
|
3256
3141
|
|
|
3257
|
-
|
|
3258
|
-
|
|
3259
|
-
title: Permissions
|
|
3260
|
-
subtitle: Control what your API keys can access with granular permissions.
|
|
3261
|
-
slug: permissions
|
|
3262
|
-
description: Learn how to configure fine-grained permissions on API keys to restrict access to specific resources and operations.
|
|
3263
|
-
---------------------
|
|
3142
|
+
# Permissions
|
|
3264
3143
|
|
|
3265
|
-
|
|
3144
|
+
> Learn how to configure fine-grained permissions on API keys to restrict access to specific resources and operations.
|
|
3266
3145
|
|
|
3267
3146
|
## What are Permissions?
|
|
3268
3147
|
|
|
@@ -3694,15 +3573,9 @@ Copy one of the blocks below into Cursor or Claude for complete Permissions API
|
|
|
3694
3573
|
* **Combine with scopes for defense in depth.** Pair permissions with [pod-scoped](/multi-tenancy#pod-scoped-keys) or [inbox-scoped](/multi-tenancy#inbox-scoped-keys) keys. Scopes limit *which* resources a key can see, while permissions limit *what* it can do.
|
|
3695
3574
|
* **Filter unwanted content from agents.** Set `label_spam_read`, `label_blocked_read`, and `label_trash_read` to `false` on agent-facing keys. This prevents agents from seeing or processing unwanted email, keeping their context clean.
|
|
3696
3575
|
|
|
3697
|
-
|
|
3698
|
-
|
|
3699
|
-
title: Agent Onboarding
|
|
3700
|
-
subtitle: Everything you need to onboard your AI agent to AgentMail
|
|
3701
|
-
slug: agent-onboarding
|
|
3702
|
-
description: Resources for AI coding assistants, MCP servers, skills, and agent-friendly documentation.
|
|
3703
|
-
---------------------
|
|
3576
|
+
# Agent Onboarding
|
|
3704
3577
|
|
|
3705
|
-
|
|
3578
|
+
> Resources for AI coding assistants, MCP servers, skills, and agent-friendly documentation.
|
|
3706
3579
|
|
|
3707
3580
|
> Everything you need to onboard your AI agent to AgentMail — the email platform built for AI agents.
|
|
3708
3581
|
|
|
@@ -3804,19 +3677,25 @@ You can selectively enable specific tools using the `--tools` argument:
|
|
|
3804
3677
|
|
|
3805
3678
|
### Available MCP Tools
|
|
3806
3679
|
|
|
3807
|
-
| Tool | Description
|
|
3808
|
-
| ------------------ |
|
|
3809
|
-
| `create_inbox` | Create a new email inbox for an agent
|
|
3810
|
-
| `list_inboxes` | List all inboxes in your account
|
|
3811
|
-
| `get_inbox` | Get details of a specific inbox
|
|
3812
|
-
| `delete_inbox` | Delete an inbox
|
|
3813
|
-
| `send_message` | Send an email from an agent inbox
|
|
3814
|
-
| `reply_to_message` | Reply to an email in a thread
|
|
3815
|
-
| `forward_message` | Forward an email
|
|
3816
|
-
| `update_message` | Update message labels or status
|
|
3817
|
-
| `
|
|
3818
|
-
| `
|
|
3819
|
-
| `
|
|
3680
|
+
| Tool | Description |
|
|
3681
|
+
| ------------------ | --------------------------------------------------------------- |
|
|
3682
|
+
| `create_inbox` | Create a new email inbox for an agent |
|
|
3683
|
+
| `list_inboxes` | List all inboxes in your account |
|
|
3684
|
+
| `get_inbox` | Get details of a specific inbox |
|
|
3685
|
+
| `delete_inbox` | Delete an inbox |
|
|
3686
|
+
| `send_message` | Send an email from an agent inbox |
|
|
3687
|
+
| `reply_to_message` | Reply to an email in a thread |
|
|
3688
|
+
| `forward_message` | Forward an email |
|
|
3689
|
+
| `update_message` | Update message labels or status |
|
|
3690
|
+
| `create_draft` | Create a draft email (optionally scheduled via `send_at`) |
|
|
3691
|
+
| `list_drafts` | List drafts in an inbox (filter by labels like `scheduled`) |
|
|
3692
|
+
| `get_draft` | Get a draft by ID with content and scheduled send time |
|
|
3693
|
+
| `update_draft` | Update a draft; use `send_at` to reschedule |
|
|
3694
|
+
| `send_draft` | Send a draft immediately (draft is converted to a sent message) |
|
|
3695
|
+
| `delete_draft` | Delete a draft; also cancels a scheduled send |
|
|
3696
|
+
| `list_threads` | List email threads in an inbox |
|
|
3697
|
+
| `get_thread` | Get a full email thread with messages |
|
|
3698
|
+
| `get_attachment` | Download an email attachment |
|
|
3820
3699
|
|
|
3821
3700
|
<Card title="MCP Server on GitHub" icon="fa-brands fa-github" href="https://github.com/agentmail-to/agentmail-smithery-mcp">
|
|
3822
3701
|
View the source code, contribute, or report issues.
|
|
@@ -4057,15 +3936,9 @@ Unlike traditional email APIs that are built for one-way transactional email, Ag
|
|
|
4057
3936
|
</Card>
|
|
4058
3937
|
</CardGroup>
|
|
4059
3938
|
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
title: Skills
|
|
4063
|
-
subtitle: Add AgentMail to AI coding assistants with the official skill
|
|
4064
|
-
slug: integrations/skills
|
|
4065
|
-
description: AgentMail's official skill for OpenClaw, Claude Code, Cursor, and other AI assistants
|
|
4066
|
-
---------------------
|
|
3939
|
+
# Skills
|
|
4067
3940
|
|
|
4068
|
-
|
|
3941
|
+
> AgentMail's official skill for OpenClaw, Claude Code, Cursor, and other AI assistants
|
|
4069
3942
|
|
|
4070
3943
|
## Getting started
|
|
4071
3944
|
|
|
@@ -4189,15 +4062,9 @@ Once installed, you can ask your AI assistant to perform email tasks:
|
|
|
4189
4062
|
* [AgentMail API Reference](/api-reference)
|
|
4190
4063
|
* [AgentMail Console](https://console.agentmail.to)
|
|
4191
4064
|
|
|
4192
|
-
|
|
4065
|
+
# MCP
|
|
4193
4066
|
|
|
4194
|
-
|
|
4195
|
-
subtitle: Connect AgentMail to any MCP-compatible AI client
|
|
4196
|
-
slug: integrations/mcp
|
|
4197
|
-
description: AgentMail's Model Context Protocol (MCP) integration
|
|
4198
|
-
---------------------
|
|
4199
|
-
|
|
4200
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
4067
|
+
> AgentMail's Model Context Protocol (MCP) integration
|
|
4201
4068
|
|
|
4202
4069
|
## Getting started
|
|
4203
4070
|
|
|
@@ -4208,10 +4075,10 @@ The Model Context Protocol (MCP) is an open standard that enables AI application
|
|
|
4208
4075
|
Install with:
|
|
4209
4076
|
|
|
4210
4077
|
```bash
|
|
4211
|
-
npx add-mcp https://mcp.agentmail.to
|
|
4078
|
+
npx add-mcp https://mcp.agentmail.to/mcp
|
|
4212
4079
|
```
|
|
4213
4080
|
|
|
4214
|
-
Configure your API key when prompted. Get your key from the [AgentMail Console](https://console.agentmail.to). For more details, visit [mcp.agentmail.to](https://mcp.agentmail.to).
|
|
4081
|
+
Configure your API key when prompted. Get your key from the [AgentMail Console](https://console.agentmail.to). For more details, visit [mcp.agentmail.to/mcp](https://mcp.agentmail.to/mcp).
|
|
4215
4082
|
|
|
4216
4083
|
## Features
|
|
4217
4084
|
|
|
@@ -4219,6 +4086,7 @@ The AgentMail MCP server provides tools for:
|
|
|
4219
4086
|
|
|
4220
4087
|
* **Inbox management:** Create, list, and delete inboxes
|
|
4221
4088
|
* **Message operations:** Send, receive, and reply to emails
|
|
4089
|
+
* **Drafts:** Create, schedule, update, and send draft emails
|
|
4222
4090
|
* **Thread management:** Access and manage email threads
|
|
4223
4091
|
* **Attachments:** Handle email attachments
|
|
4224
4092
|
|
|
@@ -4231,17 +4099,11 @@ The AgentMail MCP server works with any MCP-compatible client, including:
|
|
|
4231
4099
|
* Windsurf
|
|
4232
4100
|
* Other MCP-enabled AI applications
|
|
4233
4101
|
|
|
4234
|
-
For detailed setup instructions and available tools, visit [mcp.agentmail.to](https://mcp.agentmail.to).
|
|
4102
|
+
For detailed setup instructions and available tools, visit [mcp.agentmail.to/mcp](https://mcp.agentmail.to/mcp).
|
|
4235
4103
|
|
|
4236
|
-
|
|
4104
|
+
# CLI
|
|
4237
4105
|
|
|
4238
|
-
|
|
4239
|
-
subtitle: Manage AgentMail resources from the command line
|
|
4240
|
-
slug: integrations/cli
|
|
4241
|
-
description: AgentMail's official command-line interface
|
|
4242
|
-
---------------------
|
|
4243
|
-
|
|
4244
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
4106
|
+
> AgentMail's official command-line interface
|
|
4245
4107
|
|
|
4246
4108
|
## Getting started
|
|
4247
4109
|
|
|
@@ -4351,15 +4213,9 @@ openclaw skills install agentmail-to/agentmail-skills/agentmail-cli
|
|
|
4351
4213
|
|
|
4352
4214
|
This works with any compatible tool, including OpenClaw, Claude Code, Cursor, and Codex. See the [Skills](/integrations/skills) page for more details.
|
|
4353
4215
|
|
|
4354
|
-
|
|
4355
|
-
|
|
4356
|
-
title: Google ADK
|
|
4357
|
-
subtitle: Give your Google ADK agent its own email inbox
|
|
4358
|
-
slug: integrations/google-adk
|
|
4359
|
-
description: AgentMail's Google Agent Development Kit (ADK) integration
|
|
4360
|
-
---------------------
|
|
4216
|
+
# Google ADK
|
|
4361
4217
|
|
|
4362
|
-
|
|
4218
|
+
> AgentMail's Google Agent Development Kit (ADK) integration
|
|
4363
4219
|
|
|
4364
4220
|
## Getting started
|
|
4365
4221
|
|
|
@@ -4470,15 +4326,20 @@ Once connected, your ADK agent has access to the following AgentMail tools:
|
|
|
4470
4326
|
| `forward_message` | Forward a message to another recipient |
|
|
4471
4327
|
| `update_message` | Update message properties such as read status |
|
|
4472
4328
|
|
|
4473
|
-
|
|
4329
|
+
### Draft management
|
|
4330
|
+
|
|
4331
|
+
| Tool | Description |
|
|
4332
|
+
| -------------- | --------------------------------------------------------- |
|
|
4333
|
+
| `create_draft` | Create a draft email (optionally scheduled via `send_at`) |
|
|
4334
|
+
| `list_drafts` | List drafts in an inbox |
|
|
4335
|
+
| `get_draft` | Get a specific draft by ID |
|
|
4336
|
+
| `update_draft` | Update a draft or reschedule a scheduled send |
|
|
4337
|
+
| `send_draft` | Send a draft immediately |
|
|
4338
|
+
| `delete_draft` | Delete a draft or cancel a scheduled send |
|
|
4474
4339
|
|
|
4475
|
-
|
|
4476
|
-
subtitle: Give your OpenClaw agent its own email inbox
|
|
4477
|
-
slug: integrations/openclaw
|
|
4478
|
-
description: AgentMail's OpenClaw integration
|
|
4479
|
-
---------------------
|
|
4340
|
+
# OpenClaw
|
|
4480
4341
|
|
|
4481
|
-
|
|
4342
|
+
> AgentMail's OpenClaw integration
|
|
4482
4343
|
|
|
4483
4344
|
## Getting started
|
|
4484
4345
|
|
|
@@ -4699,15 +4560,9 @@ Now OpenClaw will be notified whenever a new email arrives, allowing it to proac
|
|
|
4699
4560
|
* [OpenClaw Documentation](https://docs.openclaw.ai)
|
|
4700
4561
|
* [OpenClaw Skills Guide](https://docs.openclaw.ai/tools/skills)
|
|
4701
4562
|
|
|
4702
|
-
|
|
4563
|
+
# Replit
|
|
4703
4564
|
|
|
4704
|
-
|
|
4705
|
-
subtitle: Integrate AgentMail with your Replit apps and agents
|
|
4706
|
-
slug: integrations/replit
|
|
4707
|
-
description: AgentMail's Replit integration
|
|
4708
|
-
---------------------
|
|
4709
|
-
|
|
4710
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
4565
|
+
> AgentMail's Replit integration
|
|
4711
4566
|
|
|
4712
4567
|
## Getting started
|
|
4713
4568
|
|
|
@@ -4916,15 +4771,9 @@ Email is critical to identity and communication on the internet. Much of the con
|
|
|
4916
4771
|
|
|
4917
4772
|
These are just a few select verticals, but we have seen AgentMail be effective in automating any email task across every function. If a human does it with email, it can be automated with AgentMail.
|
|
4918
4773
|
|
|
4919
|
-
|
|
4774
|
+
# x402
|
|
4920
4775
|
|
|
4921
|
-
|
|
4922
|
-
subtitle: Pay-per-use AgentMail with the x402 payment protocol
|
|
4923
|
-
slug: integrations/x402
|
|
4924
|
-
description: AgentMail's x402 integration for HTTP-native payments
|
|
4925
|
-
---------------------
|
|
4926
|
-
|
|
4927
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
4776
|
+
> AgentMail's x402 integration for HTTP-native payments
|
|
4928
4777
|
|
|
4929
4778
|
## Getting started
|
|
4930
4779
|
|
|
@@ -5079,15 +4928,9 @@ This means your agent can use the full AgentMail API (inboxes, messages, threads
|
|
|
5079
4928
|
* [AgentMail API reference](/api-reference)
|
|
5080
4929
|
* [WebSockets overview](/websockets)
|
|
5081
4930
|
|
|
5082
|
-
|
|
5083
|
-
|
|
5084
|
-
title: MPP
|
|
5085
|
-
subtitle: Pay-per-use AgentMail with Stripe's Machine Payments Protocol
|
|
5086
|
-
slug: integrations/mpp
|
|
5087
|
-
description: AgentMail's MPP integration for machine-to-machine payments via Stripe
|
|
5088
|
-
---------------------
|
|
4931
|
+
# MPP
|
|
5089
4932
|
|
|
5090
|
-
|
|
4933
|
+
> AgentMail's MPP integration for machine-to-machine payments via Stripe
|
|
5091
4934
|
|
|
5092
4935
|
## Getting started
|
|
5093
4936
|
|
|
@@ -5175,15 +5018,9 @@ This means your agent can use the full AgentMail API (inboxes, messages, threads
|
|
|
5175
5018
|
* [AgentMail API reference](/api-reference)
|
|
5176
5019
|
* [WebSockets overview](/websockets)
|
|
5177
5020
|
|
|
5178
|
-
|
|
5021
|
+
# Integrate LiveKit Agents
|
|
5179
5022
|
|
|
5180
|
-
|
|
5181
|
-
subtitle: Build a voice assistant with real time email capabilities.
|
|
5182
|
-
slug: integrate-livekit-agents
|
|
5183
|
-
description: A step-by-step guide to integrate with the LiveKit Agents SDK.
|
|
5184
|
-
---------------------
|
|
5185
|
-
|
|
5186
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
5023
|
+
> A step-by-step guide to integrate with the LiveKit Agents SDK.
|
|
5187
5024
|
|
|
5188
5025
|
## Overview
|
|
5189
5026
|
|
|
@@ -5310,15 +5147,9 @@ Run your agent inside the terminal and send it an email
|
|
|
5310
5147
|
python agent.py console
|
|
5311
5148
|
```
|
|
5312
5149
|
|
|
5313
|
-
|
|
5314
|
-
|
|
5315
|
-
title: Sim.ai
|
|
5316
|
-
subtitle: Connect AgentMail to your Sim.ai workflows
|
|
5317
|
-
slug: integrations/sim
|
|
5318
|
-
description: AgentMail's Sim.ai integration
|
|
5319
|
-
---------------------
|
|
5150
|
+
# Sim.ai
|
|
5320
5151
|
|
|
5321
|
-
|
|
5152
|
+
> AgentMail's Sim.ai integration
|
|
5322
5153
|
|
|
5323
5154
|
## Getting started
|
|
5324
5155
|
|
|
@@ -5387,15 +5218,9 @@ Once connected, Sim provides access to the following AgentMail operations:
|
|
|
5387
5218
|
* [AgentMail API reference](/api-reference)
|
|
5388
5219
|
* [Webhooks overview](/webhooks/webhooks-overview)
|
|
5389
5220
|
|
|
5390
|
-
|
|
5391
|
-
|
|
5392
|
-
title: Guide: Sending & Receiving Email
|
|
5393
|
-
subtitle: Building your first conversational agent workflow.
|
|
5394
|
-
slug: sending-receiving-email
|
|
5395
|
-
description: A step-by-step guide to the practical workflow of sending initial emails and handling replies to have a full conversation.
|
|
5396
|
-
---------------------
|
|
5221
|
+
# Guide: Sending & Receiving Email
|
|
5397
5222
|
|
|
5398
|
-
|
|
5223
|
+
> A step-by-step guide to the practical workflow of sending initial emails and handling replies to have a full conversation.
|
|
5399
5224
|
|
|
5400
5225
|
This guide walks you through the complete, practical workflow of an agent having a conversation. While the `Core Concepts` pages detail the individual API calls, this guide shows you how to stitch them together to create a functional conversational loop.
|
|
5401
5226
|
|
|
@@ -5591,15 +5416,9 @@ Create a `Draft` with the `send_at` field and AgentMail handles the rest. The em
|
|
|
5591
5416
|
For more details on scheduled sending—including how to cancel, reschedule, list scheduled drafts, and build conditional follow-up workflows—see the [**Drafts**](/drafts) page.
|
|
5592
5417
|
</Callout>
|
|
5593
5418
|
|
|
5594
|
-
|
|
5595
|
-
|
|
5596
|
-
title: IMAP & SMTP
|
|
5597
|
-
subtitle: Connect to AgentMail with standard email protocols
|
|
5598
|
-
slug: imap-smtp
|
|
5599
|
-
description: Configure IMAP and SMTP to access your AgentMail inboxes using email clients or programmatic access.
|
|
5600
|
-
---------------------
|
|
5419
|
+
# IMAP & SMTP
|
|
5601
5420
|
|
|
5602
|
-
|
|
5421
|
+
> Configure IMAP and SMTP to access your AgentMail inboxes using email clients or programmatic access.
|
|
5603
5422
|
|
|
5604
5423
|
<Callout intent="warn" title="IMAP is Under Development">
|
|
5605
5424
|
IMAP support is currently under development and will be available in the coming weeks. The documentation below describes the planned functionality. SMTP is fully available today.
|
|
@@ -5838,15 +5657,9 @@ sendEmail().catch(console.error);
|
|
|
5838
5657
|
| Access to all folders | API |
|
|
5839
5658
|
| Bulk operations | API |
|
|
5840
5659
|
|
|
5841
|
-
|
|
5842
|
-
|
|
5843
|
-
title: Guide: Multi-Tenancy
|
|
5844
|
-
subtitle: Pods, scoped keys, and event routing for your customers.
|
|
5845
|
-
slug: multi-tenancy
|
|
5846
|
-
description: How to use pods, scoped API keys, and webhook filtering to build multi-tenant email on AgentMail.
|
|
5847
|
-
---------------------
|
|
5660
|
+
# Guide: Multi-Tenancy
|
|
5848
5661
|
|
|
5849
|
-
|
|
5662
|
+
> How to use pods, scoped API keys, and webhook filtering to build multi-tenant email on AgentMail.
|
|
5850
5663
|
|
|
5851
5664
|
If you're building a platform where each of your customers needs their own email infrastructure, this is how you set it up. The basic idea: create a `Pod` per customer, give them a scoped API key, and route webhook events to the right place.
|
|
5852
5665
|
|
|
@@ -6132,15 +5945,9 @@ Here's what onboarding a new tenant looks like end to end:
|
|
|
6132
5945
|
```
|
|
6133
5946
|
</CodeBlocks>
|
|
6134
5947
|
|
|
6135
|
-
|
|
6136
|
-
|
|
6137
|
-
title: Using Custom Domains
|
|
6138
|
-
subtitle: Strengthen your agent's identity and improve deliverability with your own domain.
|
|
6139
|
-
slug: custom-domains
|
|
6140
|
-
description: A step-by-step guide to configuring your custom domain with AgentMail for enhanced branding and trust.
|
|
6141
|
-
---------------------
|
|
5948
|
+
# Using Custom Domains
|
|
6142
5949
|
|
|
6143
|
-
|
|
5950
|
+
> A step-by-step guide to configuring your custom domain with AgentMail for enhanced branding and trust.
|
|
6144
5951
|
|
|
6145
5952
|
## Why Use a Custom Domain?
|
|
6146
5953
|
|
|
@@ -6539,15 +6346,9 @@ DNS can be tricky. Here are some common issues and how to resolve them.
|
|
|
6539
6346
|
|
|
6540
6347
|
Check out our guide on [Email Deliverability](/email-deliverability) for tips on warming up your new domain and maintaining a healthy sender reputation.
|
|
6541
6348
|
|
|
6542
|
-
|
|
6349
|
+
# Managing Your Domains
|
|
6543
6350
|
|
|
6544
|
-
|
|
6545
|
-
subtitle: Best practices for monitoring, scaling, and optimizing your domain strategy for agent fleets.
|
|
6546
|
-
slug: managing-domains
|
|
6547
|
-
description: Learn how to manage your custom domains effectively using AgentMail's API for enhanced deliverability and reputation management.
|
|
6548
|
-
---------------------
|
|
6549
|
-
|
|
6550
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
6351
|
+
> Learn how to manage your custom domains effectively using AgentMail's API for enhanced deliverability and reputation management.
|
|
6551
6352
|
|
|
6552
6353
|
## From Setup to Strategy
|
|
6553
6354
|
|
|
@@ -6615,15 +6416,9 @@ By default, AgentMail configures your domain with a strict DMARC policy (`p=reje
|
|
|
6615
6416
|
|
|
6616
6417
|
However, this is obviously up to your discretion if you want to impose a more relaxed DMARC policy, whether its `p=none` where it doesn't do anything if both SPF and DMARC fail, or its `p=quarantine`, where it puts the mail in spam/junk. Feel free to do more research at your own discretion. You can do this by changing the value in the TXT record in your DNS configuration where the name starts with `_dmarc`.
|
|
6617
6418
|
|
|
6618
|
-
|
|
6419
|
+
# Webhooks Overview
|
|
6619
6420
|
|
|
6620
|
-
|
|
6621
|
-
subtitle: Get real-time notifications for email events.
|
|
6622
|
-
slug: webhooks-overview
|
|
6623
|
-
description: Learn how to use Webhooks to build responsive, event-driven email agents with AgentMail.
|
|
6624
|
-
---------------------
|
|
6625
|
-
|
|
6626
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
6421
|
+
> Learn how to use Webhooks to build responsive, event-driven email agents with AgentMail.
|
|
6627
6422
|
|
|
6628
6423
|
Webhooks are the best way to get real-time information about what's happening with your emails. Instead of constantly asking the AgentMail API if there's a new email (a process called polling), you can register a URL, and we will send you a `POST` request with the details as soon as an event happens.
|
|
6629
6424
|
|
|
@@ -6890,13 +6685,7 @@ Copy one of the blocks below into Cursor or Claude for complete Webhooks API kno
|
|
|
6890
6685
|
</Card>
|
|
6891
6686
|
</CardGroup>
|
|
6892
6687
|
|
|
6893
|
-
|
|
6894
|
-
|
|
6895
|
-
title: Webhook Events
|
|
6896
|
-
slug: events
|
|
6897
|
-
---------------------
|
|
6898
|
-
|
|
6899
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
6688
|
+
# Webhook Events
|
|
6900
6689
|
|
|
6901
6690
|
As mentioned in the overview, webhooks allow us to create event-driven applications.
|
|
6902
6691
|
|
|
@@ -7439,15 +7228,9 @@ For example, if you only need to trigger workflows on incoming messages, you can
|
|
|
7439
7228
|
|
|
7440
7229
|
If you have any specific webhook notifications you would like, please ping us in the `#feature-requests` channel in the [Discord](https://discord.gg/hTYatWYWBc)
|
|
7441
7230
|
|
|
7442
|
-
|
|
7443
|
-
|
|
7444
|
-
title: Webhook Setup Guide
|
|
7445
|
-
subtitle: Step-by-step guide to configure webhooks.
|
|
7446
|
-
slug: webhook-setup
|
|
7447
|
-
description: A comprehensive guide to setting up webhooks with ngrok and AgentMail, including account creation, inbox setup, and code examples.
|
|
7448
|
-
---------------------
|
|
7231
|
+
# Webhook Setup Guide
|
|
7449
7232
|
|
|
7450
|
-
|
|
7233
|
+
> A comprehensive guide to setting up webhooks with ngrok and AgentMail, including account creation, inbox setup, and code examples.
|
|
7451
7234
|
|
|
7452
7235
|
This guide walks you through the complete process of setting up webhooks to receive real-time notifications from AgentMail. You'll learn how to create an ngrok account, set up an inbox, configure webhooks, and write a simple webhook receiver.
|
|
7453
7236
|
|
|
@@ -7755,15 +7538,9 @@ For production deployments:
|
|
|
7755
7538
|
</Card>
|
|
7756
7539
|
</CardGroup>
|
|
7757
7540
|
|
|
7758
|
-
|
|
7541
|
+
# Verifying Webhooks
|
|
7759
7542
|
|
|
7760
|
-
|
|
7761
|
-
subtitle: Ensure webhook requests are authentically from AgentMail.
|
|
7762
|
-
slug: webhook-verification
|
|
7763
|
-
description: Learn how to verify webhook signatures to secure your webhook endpoints and prevent spoofed requests.
|
|
7764
|
-
---------------------
|
|
7765
|
-
|
|
7766
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
7543
|
+
> Learn how to verify webhook signatures to secure your webhook endpoints and prevent spoofed requests.
|
|
7767
7544
|
|
|
7768
7545
|
When building webhook receivers, it's critical to verify that incoming requests actually originate from AgentMail and haven't been tampered with. AgentMail uses [Svix](https://www.svix.com/) to deliver webhooks, which provides cryptographic signature verification.
|
|
7769
7546
|
|
|
@@ -8206,15 +7983,9 @@ For production, you'll need to deploy your webhook server to a hosting provider
|
|
|
8206
7983
|
</Card>
|
|
8207
7984
|
</CardGroup>
|
|
8208
7985
|
|
|
8209
|
-
|
|
7986
|
+
# WebSockets
|
|
8210
7987
|
|
|
8211
|
-
|
|
8212
|
-
subtitle: Real-time, low-latency email event streaming
|
|
8213
|
-
slug: websockets
|
|
8214
|
-
description: Learn how to use WebSockets for instant email notifications without webhooks or polling.
|
|
8215
|
-
---------------------
|
|
8216
|
-
|
|
8217
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
7988
|
+
> Learn how to use WebSockets for instant email notifications without webhooks or polling.
|
|
8218
7989
|
|
|
8219
7990
|
WebSockets provide a persistent, bidirectional connection to AgentMail for receiving email events in real-time. Unlike webhooks, WebSockets don't require a public URL or external tools like ngrok.
|
|
8220
7991
|
|
|
@@ -8657,14 +8428,7 @@ Copy one of the blocks below into Cursor or Claude for WebSockets in one shot.
|
|
|
8657
8428
|
|
|
8658
8429
|
***
|
|
8659
8430
|
|
|
8660
|
-
|
|
8661
|
-
|
|
8662
|
-
title: WebSockets Quickstart
|
|
8663
|
-
subtitle: Get started with real-time email event streaming
|
|
8664
|
-
slug: websockets/quickstart
|
|
8665
|
-
---------------------
|
|
8666
|
-
|
|
8667
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
8431
|
+
# WebSockets Quickstart
|
|
8668
8432
|
|
|
8669
8433
|
## Copy for Cursor / Claude
|
|
8670
8434
|
|
|
@@ -8752,15 +8516,9 @@ with client.websockets.connect() as socket:
|
|
|
8752
8516
|
print(f"Received message from: {msg.from_}")
|
|
8753
8517
|
```
|
|
8754
8518
|
|
|
8755
|
-
|
|
8756
|
-
|
|
8757
|
-
title: Email Deliverability
|
|
8758
|
-
subtitle: Best practices for landing your emails in the inbox, not the spam folder.
|
|
8759
|
-
slug: email-deliverability
|
|
8760
|
-
description: Learn the strategies and best practices for maximizing your email deliverability with AgentMail.
|
|
8761
|
-
---------------------
|
|
8519
|
+
# Email Deliverability
|
|
8762
8520
|
|
|
8763
|
-
|
|
8521
|
+
> Learn the strategies and best practices for maximizing your email deliverability with AgentMail.
|
|
8764
8522
|
|
|
8765
8523
|
## What is Email Deliverability?
|
|
8766
8524
|
|
|
@@ -8866,15 +8624,9 @@ The content of your email plays a huge role in whether it's seen as a valuable m
|
|
|
8866
8624
|
</Step>
|
|
8867
8625
|
</Steps>
|
|
8868
8626
|
|
|
8869
|
-
|
|
8870
|
-
|
|
8871
|
-
title: Idempotent Requests
|
|
8872
|
-
subtitle: Learn how to use idempotency keys to build safe and reliable API integrations.
|
|
8873
|
-
slug: idempotency
|
|
8874
|
-
description: A guide to using the client_id parameter in AgentMail to prevent duplicate resources and safely retry API requests.
|
|
8875
|
-
---------------------
|
|
8627
|
+
# Idempotent Requests
|
|
8876
8628
|
|
|
8877
|
-
|
|
8629
|
+
> A guide to using the client_id parameter in AgentMail to prevent duplicate resources and safely retry API requests.
|
|
8878
8630
|
|
|
8879
8631
|
## What is Idempotency?
|
|
8880
8632
|
|
|
@@ -8920,15 +8672,9 @@ To use idempotency effectively, the `client_id` you generate must be unique and
|
|
|
8920
8672
|
|
|
8921
8673
|
A common and highly effective pattern is to generate a UUID (like a `UUID v4`) on your client side for a resource you are about to create, save that UUID in your own database, and then use it as the `client_id` in the API call. This gives you a reliable key to use for any retries.
|
|
8922
8674
|
|
|
8923
|
-
|
|
8924
|
-
|
|
8925
|
-
title: Example: Event-Driven Agent
|
|
8926
|
-
subtitle: Build a proactive, event-driven GitHub agent that uses Webhooks to handle replies in real time.
|
|
8927
|
-
slug: webhook-agent
|
|
8928
|
-
description: A step-by-step guide to building a sophisticated agent that performs proactive outreach and uses webhooks for inbound message processing.
|
|
8929
|
-
---------------------
|
|
8675
|
+
# Example: Event-Driven Agent
|
|
8930
8676
|
|
|
8931
|
-
|
|
8677
|
+
> A step-by-step guide to building a sophisticated agent that performs proactive outreach and uses webhooks for inbound message processing.
|
|
8932
8678
|
|
|
8933
8679
|
This tutorial walks you through building a sophisticated, dual-mode agent. It will:
|
|
8934
8680
|
|
|
@@ -9336,13 +9082,9 @@ You now have a fully event-driven agent that can both initiate conversations and
|
|
|
9336
9082
|
```
|
|
9337
9083
|
```
|
|
9338
9084
|
|
|
9339
|
-
|
|
9340
|
-
|
|
9341
|
-
title: Auto-Reply Email Agent
|
|
9342
|
-
description: Build a simple agent that automatically responds to incoming emails with personalized messages
|
|
9343
|
-
---------------------
|
|
9085
|
+
# Auto-Reply Email Agent
|
|
9344
9086
|
|
|
9345
|
-
|
|
9087
|
+
> Build a simple agent that automatically responds to incoming emails with personalized messages
|
|
9346
9088
|
|
|
9347
9089
|
## Overview
|
|
9348
9090
|
|
|
@@ -10207,13 +9949,9 @@ Your agent now has conversation memory. When replying to follow-up emails, the A
|
|
|
10207
9949
|
|
|
10208
9950
|
If you build something cool with AgentMail, we'd love to hear about it. Share in our [Discord community](https://discord.gg/hTYatWYWBc)!
|
|
10209
9951
|
|
|
10210
|
-
|
|
10211
|
-
|
|
10212
|
-
title: Smart Email Labeling Agent
|
|
10213
|
-
description: Build an AI-powered agent that automatically classifies and labels incoming emails across multiple dimensions
|
|
10214
|
-
---------------------
|
|
9952
|
+
# Smart Email Labeling Agent
|
|
10215
9953
|
|
|
10216
|
-
|
|
9954
|
+
> Build an AI-powered agent that automatically classifies and labels incoming emails across multiple dimensions
|
|
10217
9955
|
|
|
10218
9956
|
## Overview
|
|
10219
9957
|
|
|
@@ -10922,14 +10660,9 @@ Use this data to identify bottlenecks, improve processes, and make data-driven d
|
|
|
10922
10660
|
|
|
10923
10661
|
Congratulations! You've built an AI-powered email classification system. This agent showcases how AgentMail's labeling feature can power sophisticated inbox automation and analytics.
|
|
10924
10662
|
|
|
10925
|
-
|
|
10663
|
+
# Sales Agent with WebSocket
|
|
10926
10664
|
|
|
10927
|
-
|
|
10928
|
-
slug: sales-agent-websocket
|
|
10929
|
-
description: A step-by-step guide to building an AI-powered sales agent that uses WebSocket for real-time email processing without polling or webhooks.
|
|
10930
|
-
---------------------
|
|
10931
|
-
|
|
10932
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
10665
|
+
> A step-by-step guide to building an AI-powered sales agent that uses WebSocket for real-time email processing without polling or webhooks.
|
|
10933
10666
|
|
|
10934
10667
|
## Overview
|
|
10935
10668
|
|
|
@@ -11647,8 +11380,6 @@ await socket.send_subscribe(Subscribe(inbox_ids=[
|
|
|
11647
11380
|
|
|
11648
11381
|
If you build something cool with AgentMail, we'd love to hear about it. Share in our [Discord community](https://discord.gg/hTYatWYWBc)!
|
|
11649
11382
|
|
|
11650
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
11651
|
-
|
|
11652
11383
|
# Live Email Agents
|
|
11653
11384
|
|
|
11654
11385
|
We have several deployed agents running in production that demonstrate the power of AgentMail. These agents showcase different use cases and capabilities of our platform.
|
|
@@ -11690,14 +11421,9 @@ Ready to build your own intelligent email agent? Check out our [quickstart guide
|
|
|
11690
11421
|
demo.
|
|
11691
11422
|
</Note>
|
|
11692
11423
|
|
|
11693
|
-
|
|
11694
|
-
|
|
11695
|
-
title: Frequently Asked Questions (FAQ)
|
|
11696
|
-
slug: faq
|
|
11697
|
-
description: Find answers to common questions about AgentMail, from core concepts to best practices and security.
|
|
11698
|
-
---------------------
|
|
11424
|
+
# Frequently Asked Questions (FAQ)
|
|
11699
11425
|
|
|
11700
|
-
|
|
11426
|
+
> Find answers to common questions about AgentMail, from core concepts to best practices and security.
|
|
11701
11427
|
|
|
11702
11428
|
<AccordionGroup>
|
|
11703
11429
|
<Accordion title="What is AgentMail?">
|
|
@@ -11749,15 +11475,9 @@ For clean Markdown content of this page, append .md to this URL. For the complet
|
|
|
11749
11475
|
</Accordion>
|
|
11750
11476
|
</AccordionGroup>
|
|
11751
11477
|
|
|
11752
|
-
|
|
11753
|
-
|
|
11754
|
-
title: Email Reply Extraction with Talon
|
|
11755
|
-
subtitle: Extract clean reply content from email threads using Talon library
|
|
11756
|
-
slug: talon-reply-extraction
|
|
11757
|
-
description: Learn how to use Talon to extract new content from email replies, removing quoted text with 93.8% accuracy.
|
|
11758
|
-
---------------------
|
|
11478
|
+
# Email Reply Extraction with Talon
|
|
11759
11479
|
|
|
11760
|
-
|
|
11480
|
+
> Learn how to use Talon to extract new content from email replies, removing quoted text with 93.8% accuracy.
|
|
11761
11481
|
|
|
11762
11482
|
## Why Talon?
|
|
11763
11483
|
|
|
@@ -12287,14 +12007,9 @@ TalonJS provides 90.6% accuracy with slightly faster performance (1.88ms), makin
|
|
|
12287
12007
|
* The 3.2% accuracy difference is acceptable for most use cases
|
|
12288
12008
|
</Tip>
|
|
12289
12009
|
|
|
12290
|
-
|
|
12291
|
-
|
|
12292
|
-
title: Join the AgentMail Community
|
|
12293
|
-
slug: community
|
|
12294
|
-
description: Connect with the AgentMail team and developers, share what you're building, and get support.
|
|
12295
|
-
---------------------
|
|
12010
|
+
# Join the AgentMail Community
|
|
12296
12011
|
|
|
12297
|
-
|
|
12012
|
+
> Connect with the AgentMail team and developers, share what you're building, and get support.
|
|
12298
12013
|
|
|
12299
12014
|
<CardGroup>
|
|
12300
12015
|
<Card title="Join our Discord Server" href="https://discord.com/invite/hTYatWYWBc" icon="fa-brands fa-discord">
|
|
@@ -12319,14 +12034,9 @@ For clean Markdown content of this page, append .md to this URL. For the complet
|
|
|
12319
12034
|
To learn more about our premium plans and dedicated support options, please visit our website [here](https://agentmail.to/pricing).
|
|
12320
12035
|
</Callout>
|
|
12321
12036
|
|
|
12322
|
-
|
|
12037
|
+
# Support
|
|
12323
12038
|
|
|
12324
|
-
|
|
12325
|
-
slug: support
|
|
12326
|
-
description: Get help with AgentMail through our support channels.
|
|
12327
|
-
---------------------
|
|
12328
|
-
|
|
12329
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
12039
|
+
> Get help with AgentMail through our support channels.
|
|
12330
12040
|
|
|
12331
12041
|
## Need Help?
|
|
12332
12042
|
|
|
@@ -12338,14 +12048,9 @@ For clean Markdown content of this page, append .md to this URL. For the complet
|
|
|
12338
12048
|
<Card title="Email Support" icon="fa-solid fa-envelope" href="mailto:support@agentmail.cc" />
|
|
12339
12049
|
</Cards>
|
|
12340
12050
|
|
|
12341
|
-
|
|
12051
|
+
# Understanding Email Authentication (SPF, DKIM, DMARC)
|
|
12342
12052
|
|
|
12343
|
-
|
|
12344
|
-
slug: email-protocols
|
|
12345
|
-
description: Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.
|
|
12346
|
-
---------------------
|
|
12347
|
-
|
|
12348
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
12053
|
+
> Learn why we ask for DNS records and what SPF, DKIM, and DMARC are.
|
|
12349
12054
|
|
|
12350
12055
|
When you add a custom domain to AgentMail, we ask you to add several records to your DNS settings. We understand that this can seem daunting, and we want to be completely transparent about what these records are and why they are necessary.
|
|
12351
12056
|
|
|
@@ -12418,15 +12123,9 @@ This is some records that we might give you:
|
|
|
12418
12123
|
|
|
12419
12124
|
We hope this provides a clear and transparent look into why these DNS records are required. By setting them up, you enable AgentMail to provide a secure and reliable email experience for your AI agents.
|
|
12420
12125
|
|
|
12421
|
-
|
|
12422
|
-
|
|
12423
|
-
title: SOC 2 Compliance
|
|
12424
|
-
description: AgentMail's SOC 2 Type I and Type II compliance.
|
|
12425
|
-
sidebar_position: 40
|
|
12426
|
-
lastUpdated: 2026-03-17
|
|
12427
|
-
---------------------
|
|
12126
|
+
# SOC 2 Compliance
|
|
12428
12127
|
|
|
12429
|
-
|
|
12128
|
+
> AgentMail's SOC 2 Type I and Type II compliance.
|
|
12430
12129
|
|
|
12431
12130
|
> AgentMail has achieved **SOC 2 Type I** (July 2025) and **Type II** (Q1 2026) compliance.
|
|
12432
12131
|
|
|
@@ -12554,14 +12253,9 @@ Organizations evaluating AgentMail can [request SOC 2 documentation](mailto:secu
|
|
|
12554
12253
|
|
|
12555
12254
|
***
|
|
12556
12255
|
|
|
12557
|
-
|
|
12256
|
+
# Spam & Virus Detection
|
|
12558
12257
|
|
|
12559
|
-
|
|
12560
|
-
slug: spam-virus-detection
|
|
12561
|
-
description: How AgentMail automatically scans incoming emails for spam and viruses.
|
|
12562
|
-
---------------------
|
|
12563
|
-
|
|
12564
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
12258
|
+
> How AgentMail automatically scans incoming emails for spam and viruses.
|
|
12565
12259
|
|
|
12566
12260
|
AgentMail automatically scans every inbound message for spam and viruses before it reaches your inbox. This happens transparently — there is nothing you need to configure.
|
|
12567
12261
|
|
|
@@ -12612,15 +12306,9 @@ Each thread object includes a `spam` label indicating whether it was flagged as
|
|
|
12612
12306
|
}
|
|
12613
12307
|
```
|
|
12614
12308
|
|
|
12615
|
-
|
|
12616
|
-
|
|
12617
|
-
title: API Welcome
|
|
12618
|
-
subtitle: Getting Started with AgentMail
|
|
12619
|
-
slug: api-reference
|
|
12620
|
-
description: Quick overview of the AgentMail SDK
|
|
12621
|
-
---------------------
|
|
12309
|
+
# API Welcome
|
|
12622
12310
|
|
|
12623
|
-
|
|
12311
|
+
> Quick overview of the AgentMail SDK
|
|
12624
12312
|
|
|
12625
12313
|
## Introduction
|
|
12626
12314
|
|
|
@@ -12658,8 +12346,6 @@ If you have any other languages you would like us to support, please [reach out
|
|
|
12658
12346
|
|
|
12659
12347
|
All of our SDKs are open source and available under the MIT license.
|
|
12660
12348
|
|
|
12661
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
12662
|
-
|
|
12663
12349
|
# Sign Up
|
|
12664
12350
|
|
|
12665
12351
|
POST https://api.agentmail.to/v0/agent/sign-up
|
|
@@ -12946,8 +12632,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
12946
12632
|
dataTask.resume()
|
|
12947
12633
|
```
|
|
12948
12634
|
|
|
12949
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
12950
|
-
|
|
12951
12635
|
# Verify
|
|
12952
12636
|
|
|
12953
12637
|
POST https://api.agentmail.to/v0/agent/verify
|
|
@@ -13205,8 +12889,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
13205
12889
|
dataTask.resume()
|
|
13206
12890
|
```
|
|
13207
12891
|
|
|
13208
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
13209
|
-
|
|
13210
12892
|
# List Inboxes
|
|
13211
12893
|
|
|
13212
12894
|
GET https://api.agentmail.to/v0/inboxes
|
|
@@ -13489,8 +13171,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
13489
13171
|
dataTask.resume()
|
|
13490
13172
|
```
|
|
13491
13173
|
|
|
13492
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
13493
|
-
|
|
13494
13174
|
# Get Inbox
|
|
13495
13175
|
|
|
13496
13176
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}
|
|
@@ -13756,8 +13436,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
13756
13436
|
dataTask.resume()
|
|
13757
13437
|
```
|
|
13758
13438
|
|
|
13759
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
13760
|
-
|
|
13761
13439
|
# Create Inbox
|
|
13762
13440
|
|
|
13763
13441
|
POST https://api.agentmail.to/v0/inboxes
|
|
@@ -14046,8 +13724,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
14046
13724
|
dataTask.resume()
|
|
14047
13725
|
```
|
|
14048
13726
|
|
|
14049
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
14050
|
-
|
|
14051
13727
|
# Update Inbox
|
|
14052
13728
|
|
|
14053
13729
|
PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}
|
|
@@ -14355,8 +14031,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
14355
14031
|
dataTask.resume()
|
|
14356
14032
|
```
|
|
14357
14033
|
|
|
14358
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
14359
|
-
|
|
14360
14034
|
# Delete Inbox
|
|
14361
14035
|
|
|
14362
14036
|
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}
|
|
@@ -14574,8 +14248,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
14574
14248
|
dataTask.resume()
|
|
14575
14249
|
```
|
|
14576
14250
|
|
|
14577
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
14578
|
-
|
|
14579
14251
|
# List Threads
|
|
14580
14252
|
|
|
14581
14253
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/threads
|
|
@@ -15075,8 +14747,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
15075
14747
|
dataTask.resume()
|
|
15076
14748
|
```
|
|
15077
14749
|
|
|
15078
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
15079
|
-
|
|
15080
14750
|
# Get Thread
|
|
15081
14751
|
|
|
15082
14752
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
|
|
@@ -15650,8 +15320,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
15650
15320
|
dataTask.resume()
|
|
15651
15321
|
```
|
|
15652
15322
|
|
|
15653
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
15654
|
-
|
|
15655
15323
|
# Get Attachment
|
|
15656
15324
|
|
|
15657
15325
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}/attachments/{attachment_id}
|
|
@@ -15948,8 +15616,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
15948
15616
|
dataTask.resume()
|
|
15949
15617
|
```
|
|
15950
15618
|
|
|
15951
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
15952
|
-
|
|
15953
15619
|
# Update Thread
|
|
15954
15620
|
|
|
15955
15621
|
PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
|
|
@@ -16259,8 +15925,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
16259
15925
|
dataTask.resume()
|
|
16260
15926
|
```
|
|
16261
15927
|
|
|
16262
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
16263
|
-
|
|
16264
15928
|
# Delete Thread
|
|
16265
15929
|
|
|
16266
15930
|
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
|
|
@@ -16505,8 +16169,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
16505
16169
|
dataTask.resume()
|
|
16506
16170
|
```
|
|
16507
16171
|
|
|
16508
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
16509
|
-
|
|
16510
16172
|
# List Messages
|
|
16511
16173
|
|
|
16512
16174
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages
|
|
@@ -17025,8 +16687,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
17025
16687
|
dataTask.resume()
|
|
17026
16688
|
```
|
|
17027
16689
|
|
|
17028
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
17029
|
-
|
|
17030
16690
|
# Get Message
|
|
17031
16691
|
|
|
17032
16692
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}
|
|
@@ -17473,8 +17133,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
17473
17133
|
dataTask.resume()
|
|
17474
17134
|
```
|
|
17475
17135
|
|
|
17476
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
17477
|
-
|
|
17478
17136
|
# Get Attachment
|
|
17479
17137
|
|
|
17480
17138
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/attachments/{attachment_id}
|
|
@@ -17771,8 +17429,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
17771
17429
|
dataTask.resume()
|
|
17772
17430
|
```
|
|
17773
17431
|
|
|
17774
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
17775
|
-
|
|
17776
17432
|
# Get Raw Message
|
|
17777
17433
|
|
|
17778
17434
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/raw
|
|
@@ -18035,8 +17691,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
18035
17691
|
dataTask.resume()
|
|
18036
17692
|
```
|
|
18037
17693
|
|
|
18038
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
18039
|
-
|
|
18040
17694
|
# Update Message
|
|
18041
17695
|
|
|
18042
17696
|
PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}
|
|
@@ -18349,8 +18003,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
18349
18003
|
dataTask.resume()
|
|
18350
18004
|
```
|
|
18351
18005
|
|
|
18352
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
18353
|
-
|
|
18354
18006
|
# Delete Message
|
|
18355
18007
|
|
|
18356
18008
|
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}
|
|
@@ -18587,8 +18239,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
18587
18239
|
dataTask.resume()
|
|
18588
18240
|
```
|
|
18589
18241
|
|
|
18590
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
18591
|
-
|
|
18592
18242
|
# Send Message
|
|
18593
18243
|
|
|
18594
18244
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/send
|
|
@@ -18995,8 +18645,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
18995
18645
|
dataTask.resume()
|
|
18996
18646
|
```
|
|
18997
18647
|
|
|
18998
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
18999
|
-
|
|
19000
18648
|
# Reply To Message
|
|
19001
18649
|
|
|
19002
18650
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/reply
|
|
@@ -19409,8 +19057,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
19409
19057
|
dataTask.resume()
|
|
19410
19058
|
```
|
|
19411
19059
|
|
|
19412
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
19413
|
-
|
|
19414
19060
|
# Reply All Message
|
|
19415
19061
|
|
|
19416
19062
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/reply-all
|
|
@@ -19799,8 +19445,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
19799
19445
|
dataTask.resume()
|
|
19800
19446
|
```
|
|
19801
19447
|
|
|
19802
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
19803
|
-
|
|
19804
19448
|
# Forward Message
|
|
19805
19449
|
|
|
19806
19450
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}/forward
|
|
@@ -20213,8 +19857,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
20213
19857
|
dataTask.resume()
|
|
20214
19858
|
```
|
|
20215
19859
|
|
|
20216
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
20217
|
-
|
|
20218
19860
|
# List Drafts
|
|
20219
19861
|
|
|
20220
19862
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts
|
|
@@ -20667,8 +20309,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
20667
20309
|
dataTask.resume()
|
|
20668
20310
|
```
|
|
20669
20311
|
|
|
20670
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
20671
|
-
|
|
20672
20312
|
# Get Draft
|
|
20673
20313
|
|
|
20674
20314
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}
|
|
@@ -21085,8 +20725,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
21085
20725
|
dataTask.resume()
|
|
21086
20726
|
```
|
|
21087
20727
|
|
|
21088
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
21089
|
-
|
|
21090
20728
|
# Get Attachment
|
|
21091
20729
|
|
|
21092
20730
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}/attachments/{attachment_id}
|
|
@@ -21383,8 +21021,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
21383
21021
|
dataTask.resume()
|
|
21384
21022
|
```
|
|
21385
21023
|
|
|
21386
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
21387
|
-
|
|
21388
21024
|
# Create Draft
|
|
21389
21025
|
|
|
21390
21026
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts
|
|
@@ -21873,8 +21509,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
21873
21509
|
dataTask.resume()
|
|
21874
21510
|
```
|
|
21875
21511
|
|
|
21876
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
21877
|
-
|
|
21878
21512
|
# Update Draft
|
|
21879
21513
|
|
|
21880
21514
|
PATCH https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}
|
|
@@ -22340,8 +21974,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
22340
21974
|
dataTask.resume()
|
|
22341
21975
|
```
|
|
22342
21976
|
|
|
22343
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
22344
|
-
|
|
22345
21977
|
# Delete Draft
|
|
22346
21978
|
|
|
22347
21979
|
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}
|
|
@@ -22573,8 +22205,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
22573
22205
|
dataTask.resume()
|
|
22574
22206
|
```
|
|
22575
22207
|
|
|
22576
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
22577
|
-
|
|
22578
22208
|
# Send Draft
|
|
22579
22209
|
|
|
22580
22210
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/drafts/{draft_id}/send
|
|
@@ -22895,8 +22525,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
22895
22525
|
dataTask.resume()
|
|
22896
22526
|
```
|
|
22897
22527
|
|
|
22898
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
22899
|
-
|
|
22900
22528
|
# List Entries
|
|
22901
22529
|
|
|
22902
22530
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}
|
|
@@ -23211,8 +22839,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
23211
22839
|
dataTask.resume()
|
|
23212
22840
|
```
|
|
23213
22841
|
|
|
23214
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
23215
|
-
|
|
23216
22842
|
# Get List Entry
|
|
23217
22843
|
|
|
23218
22844
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
|
|
@@ -23519,8 +23145,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
23519
23145
|
dataTask.resume()
|
|
23520
23146
|
```
|
|
23521
23147
|
|
|
23522
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
23523
|
-
|
|
23524
23148
|
# Create List Entry
|
|
23525
23149
|
|
|
23526
23150
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}
|
|
@@ -23858,8 +23482,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
23858
23482
|
dataTask.resume()
|
|
23859
23483
|
```
|
|
23860
23484
|
|
|
23861
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
23862
|
-
|
|
23863
23485
|
# Delete List Entry
|
|
23864
23486
|
|
|
23865
23487
|
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/lists/{direction}/{type}/{entry}
|
|
@@ -24115,8 +23737,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
24115
23737
|
dataTask.resume()
|
|
24116
23738
|
```
|
|
24117
23739
|
|
|
24118
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
24119
|
-
|
|
24120
23740
|
# Query Metrics
|
|
24121
23741
|
|
|
24122
23742
|
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/metrics
|
|
@@ -24426,7 +24046,339 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
24426
24046
|
dataTask.resume()
|
|
24427
24047
|
```
|
|
24428
24048
|
|
|
24429
|
-
|
|
24049
|
+
# List Inbox Events
|
|
24050
|
+
|
|
24051
|
+
GET https://api.agentmail.to/v0/inboxes/{inbox_id}/events
|
|
24052
|
+
|
|
24053
|
+
List label change events for an inbox. Returns events in reverse chronological order by default. Use for IMAP UID projection or audit logging.
|
|
24054
|
+
|
|
24055
|
+
**CLI:**
|
|
24056
|
+
```bash
|
|
24057
|
+
agentmail inboxes:events list --inbox-id <inbox_id>
|
|
24058
|
+
```
|
|
24059
|
+
|
|
24060
|
+
Reference: https://docs.agentmail.to/api-reference/inboxes/events/list
|
|
24061
|
+
|
|
24062
|
+
## OpenAPI Specification
|
|
24063
|
+
|
|
24064
|
+
```yaml
|
|
24065
|
+
openapi: 3.1.0
|
|
24066
|
+
info:
|
|
24067
|
+
title: api
|
|
24068
|
+
version: 1.0.0
|
|
24069
|
+
paths:
|
|
24070
|
+
/v0/inboxes/{inbox_id}/events:
|
|
24071
|
+
get:
|
|
24072
|
+
operationId: list
|
|
24073
|
+
summary: List Inbox Events
|
|
24074
|
+
description: >-
|
|
24075
|
+
List label change events for an inbox. Returns events in reverse
|
|
24076
|
+
chronological order by default. Use for IMAP UID projection or audit
|
|
24077
|
+
logging.
|
|
24078
|
+
|
|
24079
|
+
|
|
24080
|
+
**CLI:**
|
|
24081
|
+
|
|
24082
|
+
```bash
|
|
24083
|
+
|
|
24084
|
+
agentmail inboxes:events list --inbox-id <inbox_id>
|
|
24085
|
+
|
|
24086
|
+
```
|
|
24087
|
+
tags:
|
|
24088
|
+
- subpackage_inboxes.subpackage_inboxes/events
|
|
24089
|
+
parameters:
|
|
24090
|
+
- name: inbox_id
|
|
24091
|
+
in: path
|
|
24092
|
+
required: true
|
|
24093
|
+
schema:
|
|
24094
|
+
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
24095
|
+
- name: limit
|
|
24096
|
+
in: query
|
|
24097
|
+
required: false
|
|
24098
|
+
schema:
|
|
24099
|
+
$ref: '#/components/schemas/type_:Limit'
|
|
24100
|
+
- name: page_token
|
|
24101
|
+
in: query
|
|
24102
|
+
required: false
|
|
24103
|
+
schema:
|
|
24104
|
+
$ref: '#/components/schemas/type_:PageToken'
|
|
24105
|
+
- name: ascending
|
|
24106
|
+
in: query
|
|
24107
|
+
required: false
|
|
24108
|
+
schema:
|
|
24109
|
+
$ref: '#/components/schemas/type_:Ascending'
|
|
24110
|
+
- name: Authorization
|
|
24111
|
+
in: header
|
|
24112
|
+
description: Bearer authentication
|
|
24113
|
+
required: true
|
|
24114
|
+
schema:
|
|
24115
|
+
type: string
|
|
24116
|
+
responses:
|
|
24117
|
+
'200':
|
|
24118
|
+
description: Response with status 200
|
|
24119
|
+
content:
|
|
24120
|
+
application/json:
|
|
24121
|
+
schema:
|
|
24122
|
+
$ref: '#/components/schemas/type_inbox-events:ListInboxEventsResponse'
|
|
24123
|
+
'404':
|
|
24124
|
+
description: Error response with status 404
|
|
24125
|
+
content:
|
|
24126
|
+
application/json:
|
|
24127
|
+
schema:
|
|
24128
|
+
$ref: '#/components/schemas/type_:ErrorResponse'
|
|
24129
|
+
servers:
|
|
24130
|
+
- url: https://api.agentmail.to
|
|
24131
|
+
- url: https://x402.api.agentmail.to
|
|
24132
|
+
- url: https://mpp.api.agentmail.to
|
|
24133
|
+
- url: https://api.agentmail.eu
|
|
24134
|
+
components:
|
|
24135
|
+
schemas:
|
|
24136
|
+
type_inboxes:InboxId:
|
|
24137
|
+
type: string
|
|
24138
|
+
description: The ID of the inbox.
|
|
24139
|
+
title: InboxId
|
|
24140
|
+
type_:Limit:
|
|
24141
|
+
type: integer
|
|
24142
|
+
description: Limit of number of items returned.
|
|
24143
|
+
title: Limit
|
|
24144
|
+
type_:PageToken:
|
|
24145
|
+
type: string
|
|
24146
|
+
description: Page token for pagination.
|
|
24147
|
+
title: PageToken
|
|
24148
|
+
type_:Ascending:
|
|
24149
|
+
type: boolean
|
|
24150
|
+
description: Sort in ascending temporal order.
|
|
24151
|
+
title: Ascending
|
|
24152
|
+
type_:Count:
|
|
24153
|
+
type: integer
|
|
24154
|
+
description: Number of items returned.
|
|
24155
|
+
title: Count
|
|
24156
|
+
type_:OrganizationId:
|
|
24157
|
+
type: string
|
|
24158
|
+
description: ID of organization.
|
|
24159
|
+
title: OrganizationId
|
|
24160
|
+
type_inbox-events:InboxEventId:
|
|
24161
|
+
type: string
|
|
24162
|
+
description: ID of event.
|
|
24163
|
+
title: InboxEventId
|
|
24164
|
+
type_inbox-events:InboxEventType:
|
|
24165
|
+
type: string
|
|
24166
|
+
enum:
|
|
24167
|
+
- label_added
|
|
24168
|
+
- label_removed
|
|
24169
|
+
description: Type of inbox event.
|
|
24170
|
+
title: InboxEventType
|
|
24171
|
+
type_inbox-events:InboxEvent:
|
|
24172
|
+
type: object
|
|
24173
|
+
properties:
|
|
24174
|
+
organization_id:
|
|
24175
|
+
$ref: '#/components/schemas/type_:OrganizationId'
|
|
24176
|
+
pod_id:
|
|
24177
|
+
type: string
|
|
24178
|
+
description: ID of pod.
|
|
24179
|
+
inbox_id:
|
|
24180
|
+
$ref: '#/components/schemas/type_inboxes:InboxId'
|
|
24181
|
+
event_id:
|
|
24182
|
+
$ref: '#/components/schemas/type_inbox-events:InboxEventId'
|
|
24183
|
+
event_type:
|
|
24184
|
+
$ref: '#/components/schemas/type_inbox-events:InboxEventType'
|
|
24185
|
+
message_id:
|
|
24186
|
+
type: string
|
|
24187
|
+
description: ID of message.
|
|
24188
|
+
label:
|
|
24189
|
+
type: string
|
|
24190
|
+
description: Label added or removed.
|
|
24191
|
+
event_at:
|
|
24192
|
+
type: string
|
|
24193
|
+
format: date-time
|
|
24194
|
+
description: Time at which the event occurred.
|
|
24195
|
+
created_at:
|
|
24196
|
+
type: string
|
|
24197
|
+
format: date-time
|
|
24198
|
+
description: Time at which the event was recorded.
|
|
24199
|
+
required:
|
|
24200
|
+
- organization_id
|
|
24201
|
+
- pod_id
|
|
24202
|
+
- inbox_id
|
|
24203
|
+
- event_id
|
|
24204
|
+
- event_type
|
|
24205
|
+
- message_id
|
|
24206
|
+
- label
|
|
24207
|
+
- event_at
|
|
24208
|
+
- created_at
|
|
24209
|
+
title: InboxEvent
|
|
24210
|
+
type_inbox-events:ListInboxEventsResponse:
|
|
24211
|
+
type: object
|
|
24212
|
+
properties:
|
|
24213
|
+
count:
|
|
24214
|
+
$ref: '#/components/schemas/type_:Count'
|
|
24215
|
+
limit:
|
|
24216
|
+
$ref: '#/components/schemas/type_:Limit'
|
|
24217
|
+
next_page_token:
|
|
24218
|
+
$ref: '#/components/schemas/type_:PageToken'
|
|
24219
|
+
events:
|
|
24220
|
+
type: array
|
|
24221
|
+
items:
|
|
24222
|
+
$ref: '#/components/schemas/type_inbox-events:InboxEvent'
|
|
24223
|
+
description: Ordered by `event_id` descending.
|
|
24224
|
+
required:
|
|
24225
|
+
- count
|
|
24226
|
+
- events
|
|
24227
|
+
title: ListInboxEventsResponse
|
|
24228
|
+
type_:ErrorName:
|
|
24229
|
+
type: string
|
|
24230
|
+
description: Name of error.
|
|
24231
|
+
title: ErrorName
|
|
24232
|
+
type_:ErrorMessage:
|
|
24233
|
+
type: string
|
|
24234
|
+
description: Error message.
|
|
24235
|
+
title: ErrorMessage
|
|
24236
|
+
type_:ErrorResponse:
|
|
24237
|
+
type: object
|
|
24238
|
+
properties:
|
|
24239
|
+
name:
|
|
24240
|
+
$ref: '#/components/schemas/type_:ErrorName'
|
|
24241
|
+
message:
|
|
24242
|
+
$ref: '#/components/schemas/type_:ErrorMessage'
|
|
24243
|
+
required:
|
|
24244
|
+
- name
|
|
24245
|
+
- message
|
|
24246
|
+
title: ErrorResponse
|
|
24247
|
+
securitySchemes:
|
|
24248
|
+
Bearer:
|
|
24249
|
+
type: http
|
|
24250
|
+
scheme: bearer
|
|
24251
|
+
|
|
24252
|
+
```
|
|
24253
|
+
|
|
24254
|
+
## SDK Code Examples
|
|
24255
|
+
|
|
24256
|
+
```typescript
|
|
24257
|
+
import { AgentMailClient } from "agentmail";
|
|
24258
|
+
|
|
24259
|
+
async function main() {
|
|
24260
|
+
const client = new AgentMailClient({
|
|
24261
|
+
apiKey: "YOUR_TOKEN_HERE",
|
|
24262
|
+
});
|
|
24263
|
+
await client.inboxes.events.list("inbox_id", {});
|
|
24264
|
+
}
|
|
24265
|
+
main();
|
|
24266
|
+
|
|
24267
|
+
```
|
|
24268
|
+
|
|
24269
|
+
```python
|
|
24270
|
+
from agentmail import AgentMail
|
|
24271
|
+
|
|
24272
|
+
client = AgentMail(
|
|
24273
|
+
api_key="YOUR_TOKEN_HERE",
|
|
24274
|
+
)
|
|
24275
|
+
|
|
24276
|
+
client.inboxes.events.list(
|
|
24277
|
+
inbox_id="inbox_id",
|
|
24278
|
+
)
|
|
24279
|
+
|
|
24280
|
+
```
|
|
24281
|
+
|
|
24282
|
+
```go
|
|
24283
|
+
package main
|
|
24284
|
+
|
|
24285
|
+
import (
|
|
24286
|
+
"fmt"
|
|
24287
|
+
"net/http"
|
|
24288
|
+
"io"
|
|
24289
|
+
)
|
|
24290
|
+
|
|
24291
|
+
func main() {
|
|
24292
|
+
|
|
24293
|
+
url := "https://api.agentmail.to/v0/inboxes/inbox_id/events"
|
|
24294
|
+
|
|
24295
|
+
req, _ := http.NewRequest("GET", url, nil)
|
|
24296
|
+
|
|
24297
|
+
req.Header.Add("Authorization", "Bearer <api_key>")
|
|
24298
|
+
|
|
24299
|
+
res, _ := http.DefaultClient.Do(req)
|
|
24300
|
+
|
|
24301
|
+
defer res.Body.Close()
|
|
24302
|
+
body, _ := io.ReadAll(res.Body)
|
|
24303
|
+
|
|
24304
|
+
fmt.Println(res)
|
|
24305
|
+
fmt.Println(string(body))
|
|
24306
|
+
|
|
24307
|
+
}
|
|
24308
|
+
```
|
|
24309
|
+
|
|
24310
|
+
```ruby
|
|
24311
|
+
require 'uri'
|
|
24312
|
+
require 'net/http'
|
|
24313
|
+
|
|
24314
|
+
url = URI("https://api.agentmail.to/v0/inboxes/inbox_id/events")
|
|
24315
|
+
|
|
24316
|
+
http = Net::HTTP.new(url.host, url.port)
|
|
24317
|
+
http.use_ssl = true
|
|
24318
|
+
|
|
24319
|
+
request = Net::HTTP::Get.new(url)
|
|
24320
|
+
request["Authorization"] = 'Bearer <api_key>'
|
|
24321
|
+
|
|
24322
|
+
response = http.request(request)
|
|
24323
|
+
puts response.read_body
|
|
24324
|
+
```
|
|
24325
|
+
|
|
24326
|
+
```java
|
|
24327
|
+
import com.mashape.unirest.http.HttpResponse;
|
|
24328
|
+
import com.mashape.unirest.http.Unirest;
|
|
24329
|
+
|
|
24330
|
+
HttpResponse<String> response = Unirest.get("https://api.agentmail.to/v0/inboxes/inbox_id/events")
|
|
24331
|
+
.header("Authorization", "Bearer <api_key>")
|
|
24332
|
+
.asString();
|
|
24333
|
+
```
|
|
24334
|
+
|
|
24335
|
+
```php
|
|
24336
|
+
<?php
|
|
24337
|
+
require_once('vendor/autoload.php');
|
|
24338
|
+
|
|
24339
|
+
$client = new \GuzzleHttp\Client();
|
|
24340
|
+
|
|
24341
|
+
$response = $client->request('GET', 'https://api.agentmail.to/v0/inboxes/inbox_id/events', [
|
|
24342
|
+
'headers' => [
|
|
24343
|
+
'Authorization' => 'Bearer <api_key>',
|
|
24344
|
+
],
|
|
24345
|
+
]);
|
|
24346
|
+
|
|
24347
|
+
echo $response->getBody();
|
|
24348
|
+
```
|
|
24349
|
+
|
|
24350
|
+
```csharp
|
|
24351
|
+
using RestSharp;
|
|
24352
|
+
|
|
24353
|
+
var client = new RestClient("https://api.agentmail.to/v0/inboxes/inbox_id/events");
|
|
24354
|
+
var request = new RestRequest(Method.GET);
|
|
24355
|
+
request.AddHeader("Authorization", "Bearer <api_key>");
|
|
24356
|
+
IRestResponse response = client.Execute(request);
|
|
24357
|
+
```
|
|
24358
|
+
|
|
24359
|
+
```swift
|
|
24360
|
+
import Foundation
|
|
24361
|
+
|
|
24362
|
+
let headers = ["Authorization": "Bearer <api_key>"]
|
|
24363
|
+
|
|
24364
|
+
let request = NSMutableURLRequest(url: NSURL(string: "https://api.agentmail.to/v0/inboxes/inbox_id/events")! as URL,
|
|
24365
|
+
cachePolicy: .useProtocolCachePolicy,
|
|
24366
|
+
timeoutInterval: 10.0)
|
|
24367
|
+
request.httpMethod = "GET"
|
|
24368
|
+
request.allHTTPHeaderFields = headers
|
|
24369
|
+
|
|
24370
|
+
let session = URLSession.shared
|
|
24371
|
+
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
|
|
24372
|
+
if (error != nil) {
|
|
24373
|
+
print(error as Any)
|
|
24374
|
+
} else {
|
|
24375
|
+
let httpResponse = response as? HTTPURLResponse
|
|
24376
|
+
print(httpResponse)
|
|
24377
|
+
}
|
|
24378
|
+
})
|
|
24379
|
+
|
|
24380
|
+
dataTask.resume()
|
|
24381
|
+
```
|
|
24430
24382
|
|
|
24431
24383
|
# List API Keys
|
|
24432
24384
|
|
|
@@ -24849,8 +24801,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
24849
24801
|
dataTask.resume()
|
|
24850
24802
|
```
|
|
24851
24803
|
|
|
24852
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
24853
|
-
|
|
24854
24804
|
# Create API Key
|
|
24855
24805
|
|
|
24856
24806
|
POST https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys
|
|
@@ -25280,8 +25230,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
25280
25230
|
dataTask.resume()
|
|
25281
25231
|
```
|
|
25282
25232
|
|
|
25283
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
25284
|
-
|
|
25285
25233
|
# Delete API Key
|
|
25286
25234
|
|
|
25287
25235
|
DELETE https://api.agentmail.to/v0/inboxes/{inbox_id}/api-keys/{api_key_id}
|
|
@@ -25513,8 +25461,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
25513
25461
|
dataTask.resume()
|
|
25514
25462
|
```
|
|
25515
25463
|
|
|
25516
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
25517
|
-
|
|
25518
25464
|
# List Threads
|
|
25519
25465
|
|
|
25520
25466
|
GET https://api.agentmail.to/v0/threads
|
|
@@ -26007,8 +25953,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
26007
25953
|
dataTask.resume()
|
|
26008
25954
|
```
|
|
26009
25955
|
|
|
26010
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
26011
|
-
|
|
26012
25956
|
# Get Thread
|
|
26013
25957
|
|
|
26014
25958
|
GET https://api.agentmail.to/v0/threads/{thread_id}
|
|
@@ -26572,8 +26516,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
26572
26516
|
dataTask.resume()
|
|
26573
26517
|
```
|
|
26574
26518
|
|
|
26575
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
26576
|
-
|
|
26577
26519
|
# Get Attachment
|
|
26578
26520
|
|
|
26579
26521
|
GET https://api.agentmail.to/v0/threads/{thread_id}/attachments/{attachment_id}
|
|
@@ -26860,8 +26802,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
26860
26802
|
dataTask.resume()
|
|
26861
26803
|
```
|
|
26862
26804
|
|
|
26863
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
26864
|
-
|
|
26865
26805
|
# Update Thread
|
|
26866
26806
|
|
|
26867
26807
|
PATCH https://api.agentmail.to/v0/threads/{thread_id}
|
|
@@ -27161,8 +27101,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
27161
27101
|
dataTask.resume()
|
|
27162
27102
|
```
|
|
27163
27103
|
|
|
27164
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
27165
|
-
|
|
27166
27104
|
# Delete Thread
|
|
27167
27105
|
|
|
27168
27106
|
DELETE https://api.agentmail.to/v0/threads/{thread_id}
|
|
@@ -27396,8 +27334,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
27396
27334
|
dataTask.resume()
|
|
27397
27335
|
```
|
|
27398
27336
|
|
|
27399
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
27400
|
-
|
|
27401
27337
|
# List Drafts
|
|
27402
27338
|
|
|
27403
27339
|
GET https://api.agentmail.to/v0/drafts
|
|
@@ -27843,8 +27779,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
27843
27779
|
dataTask.resume()
|
|
27844
27780
|
```
|
|
27845
27781
|
|
|
27846
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
27847
|
-
|
|
27848
27782
|
# Get Draft
|
|
27849
27783
|
|
|
27850
27784
|
GET https://api.agentmail.to/v0/drafts/{draft_id}
|
|
@@ -28255,8 +28189,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
28255
28189
|
dataTask.resume()
|
|
28256
28190
|
```
|
|
28257
28191
|
|
|
28258
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
28259
|
-
|
|
28260
28192
|
# Get Attachment
|
|
28261
28193
|
|
|
28262
28194
|
GET https://api.agentmail.to/v0/drafts/{draft_id}/attachments/{attachment_id}
|
|
@@ -28543,8 +28475,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
28543
28475
|
dataTask.resume()
|
|
28544
28476
|
```
|
|
28545
28477
|
|
|
28546
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
28547
|
-
|
|
28548
28478
|
# List Webhooks
|
|
28549
28479
|
|
|
28550
28480
|
GET https://api.agentmail.to/v0/webhooks
|
|
@@ -28859,8 +28789,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
28859
28789
|
dataTask.resume()
|
|
28860
28790
|
```
|
|
28861
28791
|
|
|
28862
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
28863
|
-
|
|
28864
28792
|
# Get Webhook
|
|
28865
28793
|
|
|
28866
28794
|
GET https://api.agentmail.to/v0/webhooks/{webhook_id}
|
|
@@ -29158,8 +29086,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
29158
29086
|
dataTask.resume()
|
|
29159
29087
|
```
|
|
29160
29088
|
|
|
29161
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
29162
|
-
|
|
29163
29089
|
# Create Webhook
|
|
29164
29090
|
|
|
29165
29091
|
POST https://api.agentmail.to/v0/webhooks
|
|
@@ -29513,8 +29439,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
29513
29439
|
dataTask.resume()
|
|
29514
29440
|
```
|
|
29515
29441
|
|
|
29516
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
29517
|
-
|
|
29518
29442
|
# Update Webhook
|
|
29519
29443
|
|
|
29520
29444
|
PATCH https://api.agentmail.to/v0/webhooks/{webhook_id}
|
|
@@ -29874,8 +29798,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
29874
29798
|
dataTask.resume()
|
|
29875
29799
|
```
|
|
29876
29800
|
|
|
29877
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
29878
|
-
|
|
29879
29801
|
# Delete Webhook
|
|
29880
29802
|
|
|
29881
29803
|
DELETE https://api.agentmail.to/v0/webhooks/{webhook_id}
|
|
@@ -30093,8 +30015,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
30093
30015
|
dataTask.resume()
|
|
30094
30016
|
```
|
|
30095
30017
|
|
|
30096
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
30097
|
-
|
|
30098
30018
|
# Message Received
|
|
30099
30019
|
|
|
30100
30020
|
POST
|
|
@@ -30524,8 +30444,6 @@ components:
|
|
|
30524
30444
|
|
|
30525
30445
|
```
|
|
30526
30446
|
|
|
30527
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
30528
|
-
|
|
30529
30447
|
# Message Sent
|
|
30530
30448
|
|
|
30531
30449
|
POST
|
|
@@ -30652,8 +30570,6 @@ components:
|
|
|
30652
30570
|
|
|
30653
30571
|
```
|
|
30654
30572
|
|
|
30655
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
30656
|
-
|
|
30657
30573
|
# Message Delivered
|
|
30658
30574
|
|
|
30659
30575
|
POST
|
|
@@ -30780,8 +30696,6 @@ components:
|
|
|
30780
30696
|
|
|
30781
30697
|
```
|
|
30782
30698
|
|
|
30783
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
30784
|
-
|
|
30785
30699
|
# Message Bounced
|
|
30786
30700
|
|
|
30787
30701
|
POST
|
|
@@ -30929,8 +30843,6 @@ components:
|
|
|
30929
30843
|
|
|
30930
30844
|
```
|
|
30931
30845
|
|
|
30932
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
30933
|
-
|
|
30934
30846
|
# Message Complained
|
|
30935
30847
|
|
|
30936
30848
|
POST
|
|
@@ -31065,8 +30977,6 @@ components:
|
|
|
31065
30977
|
|
|
31066
30978
|
```
|
|
31067
30979
|
|
|
31068
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
31069
|
-
|
|
31070
30980
|
# Message Rejected
|
|
31071
30981
|
|
|
31072
30982
|
POST
|
|
@@ -31191,8 +31101,6 @@ components:
|
|
|
31191
31101
|
|
|
31192
31102
|
```
|
|
31193
31103
|
|
|
31194
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
31195
|
-
|
|
31196
31104
|
# Domain Verified
|
|
31197
31105
|
|
|
31198
31106
|
POST
|
|
@@ -31388,8 +31296,6 @@ components:
|
|
|
31388
31296
|
|
|
31389
31297
|
```
|
|
31390
31298
|
|
|
31391
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
31392
|
-
|
|
31393
31299
|
# Connect
|
|
31394
31300
|
|
|
31395
31301
|
GET /v0
|
|
@@ -32401,8 +32307,6 @@ components:
|
|
|
32401
32307
|
|
|
32402
32308
|
```
|
|
32403
32309
|
|
|
32404
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
32405
|
-
|
|
32406
32310
|
# List Domains
|
|
32407
32311
|
|
|
32408
32312
|
GET https://api.agentmail.to/v0/domains
|
|
@@ -32685,8 +32589,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
32685
32589
|
dataTask.resume()
|
|
32686
32590
|
```
|
|
32687
32591
|
|
|
32688
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
32689
|
-
|
|
32690
32592
|
# Get Domain
|
|
32691
32593
|
|
|
32692
32594
|
GET https://api.agentmail.to/v0/domains/{domain_id}
|
|
@@ -33013,8 +32915,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
33013
32915
|
dataTask.resume()
|
|
33014
32916
|
```
|
|
33015
32917
|
|
|
33016
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
33017
|
-
|
|
33018
32918
|
# Get Zone File
|
|
33019
32919
|
|
|
33020
32920
|
GET https://api.agentmail.to/v0/domains/{domain_id}/zone-file
|
|
@@ -33237,8 +33137,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
33237
33137
|
dataTask.resume()
|
|
33238
33138
|
```
|
|
33239
33139
|
|
|
33240
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
33241
|
-
|
|
33242
33140
|
# Create Domain
|
|
33243
33141
|
|
|
33244
33142
|
POST https://api.agentmail.to/v0/domains
|
|
@@ -33602,8 +33500,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
33602
33500
|
dataTask.resume()
|
|
33603
33501
|
```
|
|
33604
33502
|
|
|
33605
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
33606
|
-
|
|
33607
33503
|
# Update Domain
|
|
33608
33504
|
|
|
33609
33505
|
PATCH https://api.agentmail.to/v0/domains/{domain_id}
|
|
@@ -33961,8 +33857,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
33961
33857
|
dataTask.resume()
|
|
33962
33858
|
```
|
|
33963
33859
|
|
|
33964
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
33965
|
-
|
|
33966
33860
|
# Delete Domain
|
|
33967
33861
|
|
|
33968
33862
|
DELETE https://api.agentmail.to/v0/domains/{domain_id}
|
|
@@ -34180,8 +34074,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
34180
34074
|
dataTask.resume()
|
|
34181
34075
|
```
|
|
34182
34076
|
|
|
34183
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
34184
|
-
|
|
34185
34077
|
# Verify Domain
|
|
34186
34078
|
|
|
34187
34079
|
POST https://api.agentmail.to/v0/domains/{domain_id}/verify
|
|
@@ -34399,8 +34291,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
34399
34291
|
dataTask.resume()
|
|
34400
34292
|
```
|
|
34401
34293
|
|
|
34402
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
34403
|
-
|
|
34404
34294
|
# List Entries
|
|
34405
34295
|
|
|
34406
34296
|
GET https://api.agentmail.to/v0/lists/{direction}/{type}
|
|
@@ -34694,8 +34584,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
34694
34584
|
dataTask.resume()
|
|
34695
34585
|
```
|
|
34696
34586
|
|
|
34697
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
34698
|
-
|
|
34699
34587
|
# Get List Entry
|
|
34700
34588
|
|
|
34701
34589
|
GET https://api.agentmail.to/v0/lists/{direction}/{type}/{entry}
|
|
@@ -34985,8 +34873,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
34985
34873
|
dataTask.resume()
|
|
34986
34874
|
```
|
|
34987
34875
|
|
|
34988
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
34989
|
-
|
|
34990
34876
|
# Create List Entry
|
|
34991
34877
|
|
|
34992
34878
|
POST https://api.agentmail.to/v0/lists/{direction}/{type}
|
|
@@ -35307,8 +35193,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
35307
35193
|
dataTask.resume()
|
|
35308
35194
|
```
|
|
35309
35195
|
|
|
35310
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
35311
|
-
|
|
35312
35196
|
# Delete List Entry
|
|
35313
35197
|
|
|
35314
35198
|
DELETE https://api.agentmail.to/v0/lists/{direction}/{type}/{entry}
|
|
@@ -35554,8 +35438,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
35554
35438
|
dataTask.resume()
|
|
35555
35439
|
```
|
|
35556
35440
|
|
|
35557
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
35558
|
-
|
|
35559
35441
|
# Query Metrics
|
|
35560
35442
|
|
|
35561
35443
|
GET https://api.agentmail.to/v0/metrics
|
|
@@ -35854,8 +35736,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
35854
35736
|
dataTask.resume()
|
|
35855
35737
|
```
|
|
35856
35738
|
|
|
35857
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
35858
|
-
|
|
35859
35739
|
# List API Keys
|
|
35860
35740
|
|
|
35861
35741
|
GET https://api.agentmail.to/v0/api-keys
|
|
@@ -36250,8 +36130,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
36250
36130
|
dataTask.resume()
|
|
36251
36131
|
```
|
|
36252
36132
|
|
|
36253
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
36254
|
-
|
|
36255
36133
|
# Create API Key
|
|
36256
36134
|
|
|
36257
36135
|
POST https://api.agentmail.to/v0/api-keys
|
|
@@ -36649,8 +36527,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
36649
36527
|
dataTask.resume()
|
|
36650
36528
|
```
|
|
36651
36529
|
|
|
36652
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
36653
|
-
|
|
36654
36530
|
# Delete API Key
|
|
36655
36531
|
|
|
36656
36532
|
DELETE https://api.agentmail.to/v0/api-keys/{api_key_id}
|
|
@@ -36868,8 +36744,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
36868
36744
|
dataTask.resume()
|
|
36869
36745
|
```
|
|
36870
36746
|
|
|
36871
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
36872
|
-
|
|
36873
36747
|
# List Pods
|
|
36874
36748
|
|
|
36875
36749
|
GET https://api.agentmail.to/v0/pods
|
|
@@ -37139,8 +37013,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
37139
37013
|
dataTask.resume()
|
|
37140
37014
|
```
|
|
37141
37015
|
|
|
37142
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
37143
|
-
|
|
37144
37016
|
# Get Pod
|
|
37145
37017
|
|
|
37146
37018
|
GET https://api.agentmail.to/v0/pods/{pod_id}
|
|
@@ -37393,8 +37265,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
37393
37265
|
dataTask.resume()
|
|
37394
37266
|
```
|
|
37395
37267
|
|
|
37396
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
37397
|
-
|
|
37398
37268
|
# Create Pod
|
|
37399
37269
|
|
|
37400
37270
|
POST https://api.agentmail.to/v0/pods
|
|
@@ -37669,8 +37539,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
37669
37539
|
dataTask.resume()
|
|
37670
37540
|
```
|
|
37671
37541
|
|
|
37672
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
37673
|
-
|
|
37674
37542
|
# Delete Pod
|
|
37675
37543
|
|
|
37676
37544
|
DELETE https://api.agentmail.to/v0/pods/{pod_id}
|
|
@@ -37888,8 +37756,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
37888
37756
|
dataTask.resume()
|
|
37889
37757
|
```
|
|
37890
37758
|
|
|
37891
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
37892
|
-
|
|
37893
37759
|
# List Inboxes
|
|
37894
37760
|
|
|
37895
37761
|
GET https://api.agentmail.to/v0/pods/{pod_id}/inboxes
|
|
@@ -38204,8 +38070,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
38204
38070
|
dataTask.resume()
|
|
38205
38071
|
```
|
|
38206
38072
|
|
|
38207
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
38208
|
-
|
|
38209
38073
|
# Get Inbox
|
|
38210
38074
|
|
|
38211
38075
|
GET https://api.agentmail.to/v0/pods/{pod_id}/inboxes/{inbox_id}
|
|
@@ -38477,8 +38341,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
38477
38341
|
dataTask.resume()
|
|
38478
38342
|
```
|
|
38479
38343
|
|
|
38480
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
38481
|
-
|
|
38482
38344
|
# Create Inbox
|
|
38483
38345
|
|
|
38484
38346
|
POST https://api.agentmail.to/v0/pods/{pod_id}/inboxes
|
|
@@ -38785,8 +38647,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
38785
38647
|
dataTask.resume()
|
|
38786
38648
|
```
|
|
38787
38649
|
|
|
38788
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
38789
|
-
|
|
38790
38650
|
# Update Inbox
|
|
38791
38651
|
|
|
38792
38652
|
PATCH https://api.agentmail.to/v0/pods/{pod_id}/inboxes/{inbox_id}
|
|
@@ -39096,8 +38956,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
39096
38956
|
dataTask.resume()
|
|
39097
38957
|
```
|
|
39098
38958
|
|
|
39099
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
39100
|
-
|
|
39101
38959
|
# Delete Inbox
|
|
39102
38960
|
|
|
39103
38961
|
DELETE https://api.agentmail.to/v0/pods/{pod_id}/inboxes/{inbox_id}
|
|
@@ -39325,8 +39183,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
39325
39183
|
dataTask.resume()
|
|
39326
39184
|
```
|
|
39327
39185
|
|
|
39328
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
39329
|
-
|
|
39330
39186
|
# List Threads
|
|
39331
39187
|
|
|
39332
39188
|
GET https://api.agentmail.to/v0/pods/{pod_id}/threads
|
|
@@ -39830,8 +39686,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
39830
39686
|
dataTask.resume()
|
|
39831
39687
|
```
|
|
39832
39688
|
|
|
39833
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
39834
|
-
|
|
39835
39689
|
# Get Thread
|
|
39836
39690
|
|
|
39837
39691
|
GET https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}
|
|
@@ -40405,8 +40259,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
40405
40259
|
dataTask.resume()
|
|
40406
40260
|
```
|
|
40407
40261
|
|
|
40408
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
40409
|
-
|
|
40410
40262
|
# Get Attachment
|
|
40411
40263
|
|
|
40412
40264
|
GET https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}/attachments/{attachment_id}
|
|
@@ -40703,8 +40555,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
40703
40555
|
dataTask.resume()
|
|
40704
40556
|
```
|
|
40705
40557
|
|
|
40706
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
40707
|
-
|
|
40708
40558
|
# Update Thread
|
|
40709
40559
|
|
|
40710
40560
|
PATCH https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}
|
|
@@ -41014,8 +40864,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
41014
40864
|
dataTask.resume()
|
|
41015
40865
|
```
|
|
41016
40866
|
|
|
41017
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
41018
|
-
|
|
41019
40867
|
# Delete Thread
|
|
41020
40868
|
|
|
41021
40869
|
DELETE https://api.agentmail.to/v0/pods/{pod_id}/threads/{thread_id}
|
|
@@ -41259,8 +41107,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
41259
41107
|
dataTask.resume()
|
|
41260
41108
|
```
|
|
41261
41109
|
|
|
41262
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
41263
|
-
|
|
41264
41110
|
# List Drafts
|
|
41265
41111
|
|
|
41266
41112
|
GET https://api.agentmail.to/v0/pods/{pod_id}/drafts
|
|
@@ -41717,8 +41563,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
41717
41563
|
dataTask.resume()
|
|
41718
41564
|
```
|
|
41719
41565
|
|
|
41720
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
41721
|
-
|
|
41722
41566
|
# Get Draft
|
|
41723
41567
|
|
|
41724
41568
|
GET https://api.agentmail.to/v0/pods/{pod_id}/drafts/{draft_id}
|
|
@@ -42139,8 +41983,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
42139
41983
|
dataTask.resume()
|
|
42140
41984
|
```
|
|
42141
41985
|
|
|
42142
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
42143
|
-
|
|
42144
41986
|
# Get Attachment
|
|
42145
41987
|
|
|
42146
41988
|
GET https://api.agentmail.to/v0/pods/{pod_id}/drafts/{draft_id}/attachments/{attachment_id}
|
|
@@ -42437,8 +42279,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
42437
42279
|
dataTask.resume()
|
|
42438
42280
|
```
|
|
42439
42281
|
|
|
42440
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
42441
|
-
|
|
42442
42282
|
# List Domains
|
|
42443
42283
|
|
|
42444
42284
|
GET https://api.agentmail.to/v0/pods/{pod_id}/domains
|
|
@@ -42753,8 +42593,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
42753
42593
|
dataTask.resume()
|
|
42754
42594
|
```
|
|
42755
42595
|
|
|
42756
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
42757
|
-
|
|
42758
42596
|
# Get Domain
|
|
42759
42597
|
|
|
42760
42598
|
GET https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}
|
|
@@ -43087,8 +42925,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
43087
42925
|
dataTask.resume()
|
|
43088
42926
|
```
|
|
43089
42927
|
|
|
43090
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
43091
|
-
|
|
43092
42928
|
# Get Zone File
|
|
43093
42929
|
|
|
43094
42930
|
GET https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}/zone-file
|
|
@@ -43325,8 +43161,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
43325
43161
|
dataTask.resume()
|
|
43326
43162
|
```
|
|
43327
43163
|
|
|
43328
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
43329
|
-
|
|
43330
43164
|
# Create Domain
|
|
43331
43165
|
|
|
43332
43166
|
POST https://api.agentmail.to/v0/pods/{pod_id}/domains
|
|
@@ -43696,8 +43530,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
43696
43530
|
dataTask.resume()
|
|
43697
43531
|
```
|
|
43698
43532
|
|
|
43699
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
43700
|
-
|
|
43701
43533
|
# Update Domain
|
|
43702
43534
|
|
|
43703
43535
|
PATCH https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}
|
|
@@ -44061,8 +43893,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
44061
43893
|
dataTask.resume()
|
|
44062
43894
|
```
|
|
44063
43895
|
|
|
44064
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
44065
|
-
|
|
44066
43896
|
# Delete Domain
|
|
44067
43897
|
|
|
44068
43898
|
DELETE https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}
|
|
@@ -44290,8 +44120,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
44290
44120
|
dataTask.resume()
|
|
44291
44121
|
```
|
|
44292
44122
|
|
|
44293
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
44294
|
-
|
|
44295
44123
|
# Verify Domain
|
|
44296
44124
|
|
|
44297
44125
|
POST https://api.agentmail.to/v0/pods/{pod_id}/domains/{domain_id}/verify
|
|
@@ -44519,8 +44347,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
44519
44347
|
dataTask.resume()
|
|
44520
44348
|
```
|
|
44521
44349
|
|
|
44522
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
44523
|
-
|
|
44524
44350
|
# List Entries
|
|
44525
44351
|
|
|
44526
44352
|
GET https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}
|
|
@@ -44835,8 +44661,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
44835
44661
|
dataTask.resume()
|
|
44836
44662
|
```
|
|
44837
44663
|
|
|
44838
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
44839
|
-
|
|
44840
44664
|
# Get List Entry
|
|
44841
44665
|
|
|
44842
44666
|
GET https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
|
|
@@ -45143,8 +44967,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
45143
44967
|
dataTask.resume()
|
|
45144
44968
|
```
|
|
45145
44969
|
|
|
45146
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
45147
|
-
|
|
45148
44970
|
# Create List Entry
|
|
45149
44971
|
|
|
45150
44972
|
POST https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}
|
|
@@ -45482,8 +45304,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
45482
45304
|
dataTask.resume()
|
|
45483
45305
|
```
|
|
45484
45306
|
|
|
45485
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
45486
|
-
|
|
45487
45307
|
# Delete List Entry
|
|
45488
45308
|
|
|
45489
45309
|
DELETE https://api.agentmail.to/v0/pods/{pod_id}/lists/{direction}/{type}/{entry}
|
|
@@ -45739,8 +45559,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
45739
45559
|
dataTask.resume()
|
|
45740
45560
|
```
|
|
45741
45561
|
|
|
45742
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
45743
|
-
|
|
45744
45562
|
# Query Metrics
|
|
45745
45563
|
|
|
45746
45564
|
GET https://api.agentmail.to/v0/pods/{pod_id}/metrics
|
|
@@ -46050,8 +45868,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
46050
45868
|
dataTask.resume()
|
|
46051
45869
|
```
|
|
46052
45870
|
|
|
46053
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
46054
|
-
|
|
46055
45871
|
# List API Keys
|
|
46056
45872
|
|
|
46057
45873
|
GET https://api.agentmail.to/v0/pods/{pod_id}/api-keys
|
|
@@ -46473,8 +46289,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
46473
46289
|
dataTask.resume()
|
|
46474
46290
|
```
|
|
46475
46291
|
|
|
46476
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
46477
|
-
|
|
46478
46292
|
# Create API Key
|
|
46479
46293
|
|
|
46480
46294
|
POST https://api.agentmail.to/v0/pods/{pod_id}/api-keys
|
|
@@ -46904,8 +46718,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
46904
46718
|
dataTask.resume()
|
|
46905
46719
|
```
|
|
46906
46720
|
|
|
46907
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
46908
|
-
|
|
46909
46721
|
# Delete API Key
|
|
46910
46722
|
|
|
46911
46723
|
DELETE https://api.agentmail.to/v0/pods/{pod_id}/api-keys/{api_key_id}
|
|
@@ -47137,8 +46949,6 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
47137
46949
|
dataTask.resume()
|
|
47138
46950
|
```
|
|
47139
46951
|
|
|
47140
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47141
|
-
|
|
47142
46952
|
# Get Organization
|
|
47143
46953
|
|
|
47144
46954
|
GET https://api.agentmail.to/v0/organizations
|
|
@@ -47385,14 +47195,7 @@ let dataTask = session.dataTask(with: request as URLRequest, completionHandler:
|
|
|
47385
47195
|
dataTask.resume()
|
|
47386
47196
|
```
|
|
47387
47197
|
|
|
47388
|
-
|
|
47389
|
-
|
|
47390
|
-
title: Knowledge Base
|
|
47391
|
-
subtitle: A collection of answers to frequently asked questions.
|
|
47392
|
-
slug: knowledge-base
|
|
47393
|
-
---------------------
|
|
47394
|
-
|
|
47395
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47198
|
+
# Knowledge Base
|
|
47396
47199
|
|
|
47397
47200
|
## Getting Started
|
|
47398
47201
|
|
|
@@ -47512,14 +47315,7 @@ Step-by-step instructions for verifying your domain with popular DNS providers.
|
|
|
47512
47315
|
</Card>
|
|
47513
47316
|
</Cards>
|
|
47514
47317
|
|
|
47515
|
-
|
|
47516
|
-
|
|
47517
|
-
title: What is AgentMail and how is it different?
|
|
47518
|
-
subtitle: Understand how AgentMail compares to traditional email providers.
|
|
47519
|
-
slug: knowledge-base/what-is-agentmail
|
|
47520
|
-
---------------------
|
|
47521
|
-
|
|
47522
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47318
|
+
# What is AgentMail and how is it different?
|
|
47523
47319
|
|
|
47524
47320
|
AgentMail is email infrastructure built specifically for AI agents. Unlike transactional email APIs that focus on one-way sending, AgentMail is built for two-way agent communication: dedicated inboxes, native threading, and full receiving support with no shared sending domains.
|
|
47525
47321
|
|
|
@@ -47552,14 +47348,7 @@ AgentMail is the right choice when:
|
|
|
47552
47348
|
|
|
47553
47349
|
Yes. AgentMail's send API works similarly. Replace your existing send call with `client.inboxes.messages.send()` and you get the same sending capability plus full receiving, threading, and agent identity features on top. See the [Quickstart](/quickstart) to get started in minutes.
|
|
47554
47350
|
|
|
47555
|
-
|
|
47556
|
-
|
|
47557
|
-
title: What can I do with an AgentMail inbox?
|
|
47558
|
-
subtitle: A complete overview of inbox capabilities for AI agents.
|
|
47559
|
-
slug: knowledge-base/inbox-capabilities
|
|
47560
|
-
---------------------
|
|
47561
|
-
|
|
47562
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47351
|
+
# What can I do with an AgentMail inbox?
|
|
47563
47352
|
|
|
47564
47353
|
An AgentMail inbox is a full email account for your AI agent. Each inbox gets a unique email address and can send, receive, reply, forward, and manage emails entirely through the API.
|
|
47565
47354
|
|
|
@@ -47651,14 +47440,7 @@ if threads.threads:
|
|
|
47651
47440
|
)
|
|
47652
47441
|
```
|
|
47653
47442
|
|
|
47654
|
-
|
|
47655
|
-
|
|
47656
|
-
title: How do I create my first inbox?
|
|
47657
|
-
subtitle: Get up and running with your first AgentMail inbox.
|
|
47658
|
-
slug: knowledge-base/creating-first-inbox
|
|
47659
|
-
---------------------
|
|
47660
|
-
|
|
47661
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47443
|
+
# How do I create my first inbox?
|
|
47662
47444
|
|
|
47663
47445
|
Creating an inbox gives your AI agent its own email address. You can create inboxes on the default `@agentmail.to` domain or on your own custom domain.
|
|
47664
47446
|
|
|
@@ -47751,14 +47533,7 @@ Now that you have an inbox, explore what you can do with it:
|
|
|
47751
47533
|
* [Set up webhooks](/webhook-setup) to get notified when emails arrive
|
|
47752
47534
|
* [Use labels](/labels) to track message state in your agent workflows
|
|
47753
47535
|
|
|
47754
|
-
|
|
47755
|
-
|
|
47756
|
-
title: How do I get my API key?
|
|
47757
|
-
subtitle: Create and manage your AgentMail API keys.
|
|
47758
|
-
slug: knowledge-base/getting-api-key
|
|
47759
|
-
---------------------
|
|
47760
|
-
|
|
47761
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47536
|
+
# How do I get my API key?
|
|
47762
47537
|
|
|
47763
47538
|
You need an API key to authenticate requests to the AgentMail API. API keys start with `am_` and are created in the AgentMail Console.
|
|
47764
47539
|
|
|
@@ -47822,14 +47597,7 @@ No credit card required to get started. The free tier includes:
|
|
|
47822
47597
|
|
|
47823
47598
|
To create more inboxes or send higher volumes, see the [pricing page](https://agentmail.to/pricing).
|
|
47824
47599
|
|
|
47825
|
-
|
|
47826
|
-
|
|
47827
|
-
title: How do I handle inbound emails with my agent?
|
|
47828
|
-
subtitle: Compare Webhooks and WebSockets for processing incoming emails.
|
|
47829
|
-
slug: knowledge-base/handling-inbound-emails
|
|
47830
|
-
---------------------
|
|
47831
|
-
|
|
47832
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47600
|
+
# How do I handle inbound emails with my agent?
|
|
47833
47601
|
|
|
47834
47602
|
AgentMail offers two ways to process incoming emails, each suited to different use cases.
|
|
47835
47603
|
|
|
@@ -47933,14 +47701,7 @@ See the [WebSocket Overview](/websockets) for more details.
|
|
|
47933
47701
|
|
|
47934
47702
|
For most production use cases, **webhooks** are recommended. They are reliable, event-driven, and integrate well with serverless platforms. If you need real-time events without exposing a public URL, **WebSockets** are the best option.
|
|
47935
47703
|
|
|
47936
|
-
|
|
47937
|
-
|
|
47938
|
-
title: How do I set up allowlists and blocklists?
|
|
47939
|
-
subtitle: Control who your AI agent can send to and receive from.
|
|
47940
|
-
slug: knowledge-base/allowlists-blocklists
|
|
47941
|
-
---------------------
|
|
47942
|
-
|
|
47943
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47704
|
+
# How do I set up allowlists and blocklists?
|
|
47944
47705
|
|
|
47945
47706
|
Allowlists and blocklists let you control who your AI agent can communicate with. This is a critical safety feature for autonomous agents running in production with minimal human oversight.
|
|
47946
47707
|
|
|
@@ -48081,14 +47842,7 @@ Without guardrails, an autonomous agent could email the wrong people, respond to
|
|
|
48081
47842
|
|
|
48082
47843
|
For more details on the Lists API, see the [Lists core concept](/lists) documentation.
|
|
48083
47844
|
|
|
48084
|
-
|
|
48085
|
-
|
|
48086
|
-
title: How do I manage threaded conversations?
|
|
48087
|
-
subtitle: Maintain context across multi-turn email conversations with your agent.
|
|
48088
|
-
slug: knowledge-base/threaded-conversations
|
|
48089
|
-
---------------------
|
|
48090
|
-
|
|
48091
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47845
|
+
# How do I manage threaded conversations?
|
|
48092
47846
|
|
|
48093
47847
|
Threads are how AgentMail organizes conversations. Every time your agent sends a new email, a thread is created. Replies are automatically grouped into the same thread, giving your agent full conversation context.
|
|
48094
47848
|
|
|
@@ -48212,14 +47966,7 @@ for thread in unreplied.threads:
|
|
|
48212
47966
|
* Use labels like `unreplied`, `replied`, `escalated`, and `resolved` to track conversation state
|
|
48213
47967
|
* Always reply to the **last message** in a thread to keep email headers correct
|
|
48214
47968
|
|
|
48215
|
-
|
|
48216
|
-
|
|
48217
|
-
title: How do I build a human-in-the-loop workflow?
|
|
48218
|
-
subtitle: Keep humans in control of your agent's email communications.
|
|
48219
|
-
slug: knowledge-base/human-in-the-loop
|
|
48220
|
-
---------------------
|
|
48221
|
-
|
|
48222
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
47969
|
+
# How do I build a human-in-the-loop workflow?
|
|
48223
47970
|
|
|
48224
47971
|
AgentMail provides several mechanisms for keeping humans involved when agents send emails. You can combine these approaches to match the level of oversight your workflow requires.
|
|
48225
47972
|
|
|
@@ -48319,14 +48066,7 @@ This acts as a hard safety boundary. Your agent can only email recipients you ha
|
|
|
48319
48066
|
* **Use labels consistently** across your agents so dashboards and alerting work reliably
|
|
48320
48067
|
* **Combine approaches:** for example, use allowlists for autonomous sending to known recipients, drafts for unknown recipients, and CC a human on everything during the first week
|
|
48321
48068
|
|
|
48322
|
-
|
|
48323
|
-
|
|
48324
|
-
title: How do I use Pods for multi-tenant email?
|
|
48325
|
-
subtitle: Isolate inboxes, domains, and data across tenants with Pods.
|
|
48326
|
-
slug: knowledge-base/pods-multi-tenant
|
|
48327
|
-
---------------------
|
|
48328
|
-
|
|
48329
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48069
|
+
# How do I use Pods for multi-tenant email?
|
|
48330
48070
|
|
|
48331
48071
|
Pods provide tenant isolation for multi-tenant applications. Each Pod is an isolated workspace containing its own inboxes, domains, threads, and drafts, completely separated from other Pods.
|
|
48332
48072
|
|
|
@@ -48440,14 +48180,7 @@ client.pods.delete(pod_id=pod.pod_id)
|
|
|
48440
48180
|
|
|
48441
48181
|
For more details, see the [Pods core concept](/pods) documentation.
|
|
48442
48182
|
|
|
48443
|
-
|
|
48444
|
-
|
|
48445
|
-
title: How do I use labels to track email state?
|
|
48446
|
-
subtitle: Use labels to manage agent workflow state on emails and threads.
|
|
48447
|
-
slug: knowledge-base/labels-track-state
|
|
48448
|
-
---------------------
|
|
48449
|
-
|
|
48450
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48183
|
+
# How do I use labels to track email state?
|
|
48451
48184
|
|
|
48452
48185
|
Labels are string-based tags you attach to messages and threads. They are the primary way agents track state, classify emails, and filter conversations in AgentMail.
|
|
48453
48186
|
|
|
@@ -48575,14 +48308,7 @@ for thread_item in unreplied.threads:
|
|
|
48575
48308
|
|
|
48576
48309
|
For more details, see the [Labels core concept](/labels) documentation.
|
|
48577
48310
|
|
|
48578
|
-
|
|
48579
|
-
|
|
48580
|
-
title: How do I set up a custom domain?
|
|
48581
|
-
subtitle: Send emails from your own domain instead of @agentmail.to.
|
|
48582
|
-
slug: knowledge-base/custom-domain-setup
|
|
48583
|
-
---------------------
|
|
48584
|
-
|
|
48585
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48311
|
+
# How do I set up a custom domain?
|
|
48586
48312
|
|
|
48587
48313
|
Custom domains let your agent send emails from your brand (e.g., `agent@yourcompany.com`) instead of the default `@agentmail.to`. This improves deliverability and builds trust with recipients.
|
|
48588
48314
|
|
|
@@ -48674,14 +48400,7 @@ console.log(`Created: ${inbox.inboxId}`);
|
|
|
48674
48400
|
* **One SPF record per domain:** if you already have an SPF record, merge AgentMail's `include:` into the existing record rather than creating a second one
|
|
48675
48401
|
For a detailed walkthrough, see the [Creating Custom Domains](/custom-domains) guide.
|
|
48676
48402
|
|
|
48677
|
-
|
|
48678
|
-
|
|
48679
|
-
title: How do I set up SPF, DKIM, and DMARC?
|
|
48680
|
-
subtitle: Authenticate your domain for reliable email deliverability.
|
|
48681
|
-
slug: knowledge-base/spf-dkim-dmarc
|
|
48682
|
-
---------------------
|
|
48683
|
-
|
|
48684
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48403
|
+
# How do I set up SPF, DKIM, and DMARC?
|
|
48685
48404
|
|
|
48686
48405
|
SPF, DKIM, and DMARC are three email authentication protocols that prove your emails are legitimate. They are essential for deliverability: Gmail, Outlook, and other major providers now require all three for reliable inbox placement.
|
|
48687
48406
|
|
|
@@ -48772,14 +48491,7 @@ For step-by-step DNS instructions, see our provider guides: [Cloudflare](/knowle
|
|
|
48772
48491
|
|
|
48773
48492
|
For a deeper explanation of how these protocols work, see the [SPF, DKIM, DMARC](/email-protocols) documentation.
|
|
48774
48493
|
|
|
48775
|
-
|
|
48776
|
-
|
|
48777
|
-
title: Why are my emails going to spam?
|
|
48778
|
-
subtitle: Troubleshoot and fix spam folder placement issues.
|
|
48779
|
-
slug: knowledge-base/emails-going-to-spam
|
|
48780
|
-
---------------------
|
|
48781
|
-
|
|
48782
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48494
|
+
# Why are my emails going to spam?
|
|
48783
48495
|
|
|
48784
48496
|
If your agent's emails are landing in spam instead of the inbox, work through these common causes in order. The most frequent issues are at the top.
|
|
48785
48497
|
|
|
@@ -48844,14 +48556,7 @@ If you have checked all of the above and emails are still going to spam, reach o
|
|
|
48844
48556
|
|
|
48845
48557
|
For a comprehensive guide to maximizing deliverability, see the [Email Deliverability](/email-deliverability) best practices.
|
|
48846
48558
|
|
|
48847
|
-
|
|
48848
|
-
|
|
48849
|
-
title: Warming Up
|
|
48850
|
-
subtitle: Gradually build sending reputation on a new domain or inbox.
|
|
48851
|
-
slug: knowledge-base/domain-warming
|
|
48852
|
-
---------------------
|
|
48853
|
-
|
|
48854
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48559
|
+
# Warming Up
|
|
48855
48560
|
|
|
48856
48561
|
Warming up is the process of gradually increasing your email volume on a new domain to build sender reputation with mailbox providers like Gmail, Outlook, and Yahoo.
|
|
48857
48562
|
You can connect AgentMail inboxes to Instantly and Smartlead for programmatic warm up using [SMTP credentials](https://docs.agentmail.to/imap-smtp#finding-your-credentials).
|
|
@@ -48926,14 +48631,7 @@ You can track bounces and complaints by using [Query Metrics](https://docs.agent
|
|
|
48926
48631
|
|
|
48927
48632
|
For more deliverability best practices, see the [Email Deliverability](/email-deliverability) guide.
|
|
48928
48633
|
|
|
48929
|
-
|
|
48930
|
-
|
|
48931
|
-
title: How do I avoid MX record conflicts?
|
|
48932
|
-
subtitle: Add AgentMail DNS records without breaking existing email.
|
|
48933
|
-
slug: knowledge-base/mx-record-conflicts
|
|
48934
|
-
---------------------
|
|
48935
|
-
|
|
48936
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48634
|
+
# How do I avoid MX record conflicts?
|
|
48937
48635
|
|
|
48938
48636
|
If you already use Gmail, Outlook, or another email provider for your domain, adding AgentMail's MX records could conflict with your existing setup. Here is how to avoid that.
|
|
48939
48637
|
|
|
@@ -49010,14 +48708,7 @@ Your team's email continues to flow through Gmail. Agent emails go through Agent
|
|
|
49010
48708
|
|
|
49011
48709
|
Pick whatever makes sense for your brand. The important thing is that it is a separate subdomain from your root domain's email.
|
|
49012
48710
|
|
|
49013
|
-
|
|
49014
|
-
|
|
49015
|
-
title: What does a 403 error mean?
|
|
49016
|
-
subtitle: Common causes of API 403 Forbidden errors and how to fix them.
|
|
49017
|
-
slug: knowledge-base/api-403-error
|
|
49018
|
-
---------------------
|
|
49019
|
-
|
|
49020
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48711
|
+
# What does a 403 error mean?
|
|
49021
48712
|
|
|
49022
48713
|
A `403 Forbidden` response from the AgentMail API means your request was rejected. This can happen for several reasons, and the fix depends on the cause.
|
|
49023
48714
|
|
|
@@ -49079,14 +48770,7 @@ If you get a `200` response, your key is valid and working. You can then copy th
|
|
|
49079
48770
|
|
|
49080
48771
|
If none of the above resolves your issue, reach out in our [Discord](https://discord.com/invite/hTYatWYWBc) support channel or email [support@agentmail.cc](mailto:support@agentmail.cc) with the full error response and the endpoint you are calling.
|
|
49081
48772
|
|
|
49082
|
-
|
|
49083
|
-
|
|
49084
|
-
title: What are the rate limits?
|
|
49085
|
-
subtitle: Understand AgentMail's rate limits and how to work within them.
|
|
49086
|
-
slug: knowledge-base/rate-limits
|
|
49087
|
-
---------------------
|
|
49088
|
-
|
|
49089
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48773
|
+
# What are the rate limits?
|
|
49090
48774
|
|
|
49091
48775
|
AgentMail is built for high-volume agent workflows. Limits vary by plan.
|
|
49092
48776
|
|
|
@@ -49140,14 +48824,7 @@ async function sendWithRetry(inboxId: string, params: any, maxRetries = 3) {
|
|
|
49140
48824
|
|
|
49141
48825
|
If you need higher sending volumes or more inboxes than your current plan allows, contact [support@agentmail.cc](mailto:support@agentmail.cc) or visit the [pricing page](https://agentmail.to/pricing) for enterprise options.
|
|
49142
48826
|
|
|
49143
|
-
|
|
49144
|
-
|
|
49145
|
-
title: How do I prevent duplicate sends?
|
|
49146
|
-
subtitle: Use idempotency to avoid sending the same email twice.
|
|
49147
|
-
slug: knowledge-base/preventing-duplicate-sends
|
|
49148
|
-
---------------------
|
|
49149
|
-
|
|
49150
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48827
|
+
# How do I prevent duplicate sends?
|
|
49151
48828
|
|
|
49152
48829
|
AI agents can sometimes retry requests due to network errors, timeouts, or logic bugs. Without safeguards, this can cause the same email to be sent multiple times. Here is how to prevent that.
|
|
49153
48830
|
|
|
@@ -49236,14 +48913,7 @@ Since drafts support `clientId`, creating the same draft multiple times is safe.
|
|
|
49236
48913
|
|
|
49237
48914
|
For more details, see the [Idempotent Requests](/idempotency) guide.
|
|
49238
48915
|
|
|
49239
|
-
|
|
49240
|
-
|
|
49241
|
-
title: Why is my domain not verifying?
|
|
49242
|
-
subtitle: What to do when your domain verification is stuck.
|
|
49243
|
-
slug: knowledge-base/domain-not-verifying
|
|
49244
|
-
---------------------
|
|
49245
|
-
|
|
49246
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48916
|
+
# Why is my domain not verifying?
|
|
49247
48917
|
|
|
49248
48918
|
If your domain is stuck in a pending or failed verification state, work through these common causes.
|
|
49249
48919
|
|
|
@@ -49315,14 +48985,7 @@ You can check your domain's status in the [AgentMail Console](https://console.ag
|
|
|
49315
48985
|
|
|
49316
48986
|
If you have checked all of the above and your domain is still not verifying, email [support@agentmail.cc](mailto:support@agentmail.cc) with your domain name and a screenshot of your DNS records. We can help diagnose the issue.
|
|
49317
48987
|
|
|
49318
|
-
|
|
49319
|
-
|
|
49320
|
-
title: Why are my emails bouncing?
|
|
49321
|
-
subtitle: Diagnose and resolve email bounce issues.
|
|
49322
|
-
slug: knowledge-base/emails-bouncing
|
|
49323
|
-
---------------------
|
|
49324
|
-
|
|
49325
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
48988
|
+
# Why are my emails bouncing?
|
|
49326
48989
|
|
|
49327
48990
|
A bounced email means the recipient's mail server rejected your message. Understanding the bounce type helps you take the right action.
|
|
49328
48991
|
|
|
@@ -49407,14 +49070,7 @@ await client.webhooks.create({
|
|
|
49407
49070
|
|
|
49408
49071
|
For more on maintaining healthy sending metrics, see the [Email Deliverability](/email-deliverability) best practices.
|
|
49409
49072
|
|
|
49410
|
-
|
|
49411
|
-
|
|
49412
|
-
title: Why are my emails not showing up?
|
|
49413
|
-
subtitle: The most common reason inbound emails go missing is that the sender's domain isn't authenticated.
|
|
49414
|
-
slug: knowledge-base/inbound-emails-missing
|
|
49415
|
-
---------------------
|
|
49416
|
-
|
|
49417
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
49073
|
+
# Why are my emails not showing up?
|
|
49418
49074
|
|
|
49419
49075
|
<Warning>
|
|
49420
49076
|
**The sender's domain must have SPF or DKIM configured.** To reduce spoofing and phishing, AgentMail now drops inbound emails when the sender's domain has neither SPF nor DKIM set up. If a sender reports that their email never arrived, this is the most likely cause — once they configure SPF/DKIM on their domain, their emails will start landing in your inbox again.
|
|
@@ -49500,14 +49156,7 @@ If the sender's domain does have SPF/DKIM configured and emails are still not ar
|
|
|
49500
49156
|
|
|
49501
49157
|
If none of the above resolves the issue, reach out in our [Discord](https://discord.com/invite/hTYatWYWBc) support channel or email [support@agentmail.cc](mailto:support@agentmail.cc).
|
|
49502
49158
|
|
|
49503
|
-
|
|
49504
|
-
|
|
49505
|
-
title: DNS Guide: Cloudflare
|
|
49506
|
-
subtitle: Step-by-step instructions for adding AgentMail DNS records in Cloudflare.
|
|
49507
|
-
slug: knowledge-base/dns-cloudflare
|
|
49508
|
-
---------------------
|
|
49509
|
-
|
|
49510
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
49159
|
+
# DNS Guide: Cloudflare
|
|
49511
49160
|
|
|
49512
49161
|
## Steps
|
|
49513
49162
|
|
|
@@ -49575,14 +49224,7 @@ Cloudflare DNS typically propagates within **1 to 5 minutes**, making it one of
|
|
|
49575
49224
|
|
|
49576
49225
|
* **Name field auto-strips domain:** Cloudflare removes the domain portion from the Name field automatically. If your DKIM selector is `agentmail._domainkey`, enter just that. Do not enter `agentmail._domainkey.yourdomain.com`, or the record will be created incorrectly.
|
|
49577
49226
|
|
|
49578
|
-
|
|
49579
|
-
|
|
49580
|
-
title: DNS Guide: GoDaddy
|
|
49581
|
-
subtitle: Step-by-step instructions for adding AgentMail DNS records in GoDaddy.
|
|
49582
|
-
slug: knowledge-base/dns-godaddy
|
|
49583
|
-
---------------------
|
|
49584
|
-
|
|
49585
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
49227
|
+
# DNS Guide: GoDaddy
|
|
49586
49228
|
|
|
49587
49229
|
## Steps
|
|
49588
49230
|
|
|
@@ -49647,14 +49289,7 @@ GoDaddy DNS typically propagates within **15 to 30 minutes**, but it can occasio
|
|
|
49647
49289
|
|
|
49648
49290
|
* **Parked domain or forwarding:** If your domain is parked or has forwarding enabled, GoDaddy may override your MX records. Disable parking and forwarding before setting up email receiving.
|
|
49649
49291
|
|
|
49650
|
-
|
|
49651
|
-
|
|
49652
|
-
title: DNS Guide: Route 53 (AWS)
|
|
49653
|
-
subtitle: Step-by-step instructions for adding AgentMail DNS records in AWS Route 53.
|
|
49654
|
-
slug: knowledge-base/dns-route53
|
|
49655
|
-
---------------------
|
|
49656
|
-
|
|
49657
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
49292
|
+
# DNS Guide: Route 53 (AWS)
|
|
49658
49293
|
|
|
49659
49294
|
## Steps
|
|
49660
49295
|
|
|
@@ -49740,14 +49375,7 @@ Route 53 name servers typically pick up changes within **60 seconds**, but full
|
|
|
49740
49375
|
|
|
49741
49376
|
You can also use the AWS CLI to add the record, which handles multi-string TXT values more reliably.
|
|
49742
49377
|
|
|
49743
|
-
|
|
49744
|
-
|
|
49745
|
-
title: DNS Guide: Namecheap
|
|
49746
|
-
subtitle: Step-by-step instructions for adding AgentMail DNS records in Namecheap.
|
|
49747
|
-
slug: knowledge-base/dns-namecheap
|
|
49748
|
-
---------------------
|
|
49749
|
-
|
|
49750
|
-
For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://docs.agentmail.to/llms.txt. For full content including API reference and SDK examples, see https://docs.agentmail.to/llms-full.txt.
|
|
49378
|
+
# DNS Guide: Namecheap
|
|
49751
49379
|
|
|
49752
49380
|
## Steps
|
|
49753
49381
|
|