agentmail-sdk 1.0.0 → 1.1.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/README.md +57 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# AgentMail SDK
|
|
2
|
+
|
|
3
|
+
Official SDK for the AgentMail API — email infrastructure built for AI agents.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @agentmail/sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AgentMail } from "@agentmail/sdk";
|
|
15
|
+
|
|
16
|
+
const agent = new AgentMail({
|
|
17
|
+
apiKey: "am_sk_live_...",
|
|
18
|
+
baseUrl: "https://api.agentmail.to/v1",
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
// Create an inbox
|
|
22
|
+
const inbox = await agent.inboxes.create({
|
|
23
|
+
username: "support",
|
|
24
|
+
domain: "yourdomain.com",
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
// Send an email
|
|
28
|
+
await agent.emails.send({
|
|
29
|
+
from_inbox_id: inbox.id,
|
|
30
|
+
to: ["user@example.com"],
|
|
31
|
+
subject: "Hello",
|
|
32
|
+
body: "Sent programmatically from an AI agent",
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
// Listen for incoming emails
|
|
36
|
+
agent.ws.listen(inbox.id, {
|
|
37
|
+
onEmailReceived: async (email) => {
|
|
38
|
+
console.log("New email:", email.subject);
|
|
39
|
+
},
|
|
40
|
+
});
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Features
|
|
44
|
+
|
|
45
|
+
- **Programmatic Inboxes** — Create real email addresses via API
|
|
46
|
+
- **Send & Receive** — Full email lifecycle with webhooks and WebSockets
|
|
47
|
+
- **Semantic Search** — Find emails by meaning, not just keywords
|
|
48
|
+
- **Custom Domains** — Bring your own domain with automated DNS
|
|
49
|
+
- **MCP Server** — Native integration with Claude, Cursor, and ChatGPT
|
|
50
|
+
|
|
51
|
+
## Documentation
|
|
52
|
+
|
|
53
|
+
Full API documentation: [https://api.agentmail.to/docs](https://api.agentmail.to/docs)
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT
|