You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/mcp-server/README.md
+4-70Lines changed: 4 additions & 70 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -246,8 +246,8 @@ The following tools are available in this MCP server.
246
246
247
247
### Resource `domains`:
248
248
249
-
-`create_domains` (`write`): Add a new domain for email receiving. Automatically initiates SES verification and returns required DNS records. Subdomains inherit verification from their verified parent domain.
250
-
-`retrieve_domains` (`read`): Get detailed information about a specific domain including DNS records. Use `?check=true` for live DNS and SES verification.
249
+
-`create_domains` (`write`): Add a new domain for email receiving. Automatically initiates verification and returns required DNS records. Subdomains inherit verification from their verified parent domain.
250
+
-`retrieve_domains` (`read`): Get detailed information about a specific domain including DNS records. Use `?check=true` for a live verification check.
251
251
-`update_domains` (`write`): Update catch-all email settings for a domain. Catch-all receives emails sent to any address on your domain. Domain must be verified first.
252
252
-`list_domains` (`read`): Get paginated list of domains for authenticated user with optional filtering.
253
253
-`delete_domains` (`write`): Delete a domain and all associated resources including email addresses, DNS records, and SES configurations. Root domains with subdomains must have subdomains deleted first.
@@ -263,48 +263,16 @@ The following tools are available in this MCP server.
263
263
264
264
### Resource `email_addresses`:
265
265
266
-
-`create_email_addresses` (`write`): Create a new email address for an authenticated user's domain. Automatically configures AWS SES receipt rules.
266
+
-`create_email_addresses` (`write`): Create a new email address for an authenticated user's domain, optionally routing to a webhook or endpoint.
267
267
-`retrieve_email_addresses` (`read`): Get a specific email address by ID with detailed information including routing configuration
268
268
-`update_email_addresses` (`write`): Update an email address's routing (endpoint/webhook) or active status. Cannot have both endpoint and webhook.
269
269
-`list_email_addresses` (`read`): Get paginated list of email addresses for authenticated user with optional filtering by domain, active status, and receipt rule configuration
270
-
-`delete_email_addresses` (`write`): Delete an email address and clean up associated SES receipt rules. Returns cleanup status.
270
+
-`delete_email_addresses` (`write`): Delete an email address. Returns cleanup status.
271
271
272
272
### Resource `emails`:
273
273
274
274
-`retrieve_emails` (`read`): Retrieve a single email by ID. Works for sent, received, and scheduled emails.
275
275
-`list_emails` (`read`): List all email activity (sent, received, and scheduled) with comprehensive filtering options.
276
-
277
-
**Type Filtering:**
278
-
279
-
-`all` - Returns sent, received, and scheduled emails combined (default)
280
-
-`sent` - Only outbound emails you've sent
281
-
-`received` - Only inbound emails you've received
282
-
-`scheduled` - Only emails scheduled for future delivery
283
-
284
-
**Status Filtering:**
285
-
286
-
-`delivered` - Successfully delivered emails
287
-
-`pending` - Emails currently being processed
288
-
-`failed` - Emails that failed to deliver
289
-
-`bounced` - Emails that bounced (sent only)
290
-
-`scheduled` - Emails scheduled for future delivery
291
-
-`cancelled` - Cancelled scheduled emails
292
-
-`unread` - Unread received emails
293
-
-`read` - Read received emails
294
-
-`archived` - Archived received emails
295
-
296
-
**Time Range Filtering:**
297
-
298
-
-`1h` - Last hour
299
-
-`24h` - Last 24 hours
300
-
-`7d` - Last 7 days
301
-
-`30d` - Last 30 days (default)
302
-
-`90d` - Last 90 days
303
-
-`all` - All time
304
-
305
-
**Address Filtering:**
306
-
Supports filtering by domain ID, domain name, address ID, or raw email address (e.g., '[email protected]').
307
-
308
276
-`delete_emails` (`write`): Cancel a scheduled email by ID. Only works for emails that haven't been sent yet.
309
277
-`reply_emails` (`write`): Reply to an email or thread. Accepts either an email ID or thread ID (replies to latest message in thread). Supports reply all functionality.
310
278
-`retry_emails` (`write`): Retry delivery of a received email. Can retry to a specific endpoint, retry a specific failed delivery, or retry to all configured endpoints.
@@ -325,44 +293,10 @@ The following tools are available in this MCP server.
325
293
-`inbound` - Emails you received
326
294
-`outbound` - Emails you sent (includes delivery status)
327
295
328
-
**Message Content:**
329
-
Each message includes:
330
-
331
-
- Full body content (text and HTML)
332
-
- Sender and recipient information
333
-
- Attachments metadata
334
-
- Read status and timestamps
335
-
- Threading headers (In-Reply-To, References)
336
-
337
-
**Typical Workflow:**
338
-
339
-
1. List threads using `GET /mail/threads`
340
-
2. User clicks a thread
341
-
3. Fetch full thread using this endpoint
342
-
4. Display conversation view with all messages
343
-
344
296
-`list_mail` (`read`): List email threads (conversations) for your inbox with cursor-based pagination. This is the primary endpoint for building an inbox UI.
345
297
346
298
**What is a Thread?**
347
299
A thread groups related emails together based on the In-Reply-To and References headers, similar to how Gmail groups conversations. Each thread contains both inbound (received) and outbound (sent) messages.
348
300
349
-
**Filtering:**
350
-
351
-
-`domain` - Filter by domain ID or name (e.g., 'example.com'). Returns threads where any participant matches the domain.
352
-
-`address` - Filter by email address (e.g., '[email protected]'). Returns threads where the address is a participant.
353
-
-`search` - Search in subject lines and participant emails.
354
-
-`unread` - Set to 'true' to only return threads with unread messages.
355
-
356
-
**Pagination:**
357
-
Uses cursor-based pagination for efficient infinite scroll. Pass `pagination.next_cursor` from the response as the `cursor` parameter to get the next page.
0 commit comments