diff --git a/docs.json b/docs.json index 1890949..20a2671 100644 --- a/docs.json +++ b/docs.json @@ -113,6 +113,7 @@ "nexus/reference/servers/google-slides", "nexus/reference/servers/hubspot", "nexus/reference/servers/hunter-io", + "nexus/reference/servers/imap-email", "nexus/reference/servers/linear", "nexus/reference/servers/mistral-ocr", "nexus/reference/servers/monday", diff --git a/nexus/reference/servers/imap-email.mdx b/nexus/reference/servers/imap-email.mdx new file mode 100644 index 0000000..387cf49 --- /dev/null +++ b/nexus/reference/servers/imap-email.mdx @@ -0,0 +1,152 @@ +--- +title: IMAP Email +description: Read and manage emails from any IMAP-compatible email provider +icon: "server" +--- + +## Overview + +The IMAP Email server provides read and management access to any IMAP-compatible email provider, including self-hosted servers. It supports searching, reading, organizing, and managing emails across folders. + + +**Read-only by design:** This server cannot send or compose emails. It is designed for reading and managing existing emails only. + + +## How to Add IMAP Email + + + + Add the IMAP Email server to your Nexus environment through the server directory. + + + Provide your IMAP connection details: + - **IMAP host** — your email provider's IMAP server + - **Username** — your email address + - **Password** — your password or app-specific password + - **Port** — usually 993 for SSL (default) + + + Try "List all my email folders" to verify the connection works. + + + + +**App-specific passwords:** Some email providers with 2FA enabled require app-specific passwords instead of your regular password. Check your email provider's security settings if you have trouble connecting. + + +## What You Can Do + + + + Search with multiple filters and read full email content including headers + + + List folders, check status, and navigate your mailbox structure + + + List and download attachments from any email + + + Move, copy, delete, flag, and mark emails as read/unread + + + +## Available Tools (12) + +### Folder Operations + + + + List all folders/mailboxes in the account. Use this to discover available folder names before other operations. + + + + Get folder statistics including total message count, unread count, and recent messages. + + + +### Reading Emails + + + + List emails in a folder with pagination. Returns email UIDs, subjects, senders, and dates. + + + + Fetch complete email content including subject, sender, recipients, body, and metadata. + + + + Lightweight header-only fetch for quick previews without downloading full message content. + + + +### Searching + + + + Advanced search with multiple filters including sender, recipient, subject, body text, date range, read/unread status, and flagged state. + + + +### Attachments + + + + List attachment metadata (filename, size, type) for a specific email. + + + + Download a specific attachment from an email by its index. + + + +### Managing Emails + + + + Delete one or more emails. By default moves to Trash; use `permanent=true` for permanent deletion. + + + + Move one or more emails to a different folder. + + + + Copy one or more emails to a different folder while keeping the originals. + + + + Mark emails as read/unread or flagged/unflagged. Supports batch operations on multiple UIDs. + + + +## Use Cases + +### Inbox overview +"Show me my latest 10 emails" — List recent messages with subjects and senders. + +### Unread triage +"List all unread emails in my inbox" — Quickly see what needs attention. + +### Targeted search +"Find all emails from john@example.com with 'invoice' in the subject since January 1st" — Combine multiple search filters. + +### Attachment retrieval +"List attachments in email UID 12345 and download the PDF" — Discover and download file attachments. + +### Bulk organization +"Move emails 123, 456, and 789 to the Archive folder" — Batch operations for efficient inbox management. + +### Flagging important messages +"Flag email UID 12345 as important and mark emails 100, 101, 102 as read" — Update message status in bulk. + + +**Email UIDs:** Most operations use email UIDs (unique identifiers). Use `list_emails` or `search_emails` first to get UIDs before reading or managing specific emails. + +**Folder names:** Use `list_folders` to discover available folder names. Common folders include INBOX, Sent, Drafts, Trash, and Archive, but names vary by provider. + +**Batch operations:** Delete, move, copy, and mark operations support multiple UIDs at once for efficiency. + +**Date format:** Use YYYY-MM-DD format for date searches (e.g. `2025-01-15`). +