email-smtp-imap-mcp 2.0.0 → 2.0.1

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.
Files changed (2) hide show
  1. package/README.md +47 -18
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -10,27 +10,24 @@ A clean, simple MCP server for email operations (SMTP + IMAP).
10
10
  - ✅ **Organize** (mark read, archive, flag)
11
11
  - ✅ **List folders**
12
12
 
13
- ## Quick Start
13
+ ## Installation
14
14
 
15
- ### 1. Install
15
+ ### Option 1: NPM (Recommended)
16
16
 
17
17
  ```bash
18
- npm install
19
- npm run build
18
+ npm install -g email-smtp-imap-mcp
20
19
  ```
21
20
 
22
- ### 2. Configure
23
-
24
- Create `.env`:
21
+ ### Option 2: From Source
25
22
 
26
- ```env
27
- EMAIL_ACCOUNTS_JSON={"icloud":{"smtp":{"host":"smtp.mail.me.com","port":587,"user":"your@icloud.com","password":"your-app-password"},"imap":{"host":"imap.mail.me.com","port":993},"default_from_name":"Your Name","sender_emails":["your@icloud.com","alias@domain.com"]}}
28
- DEFAULT_EMAIL_ACCOUNT=icloud
23
+ ```bash
24
+ git clone https://github.com/samihalawa/email-smtp-imap-mcp.git
25
+ cd email-smtp-imap-mcp
26
+ npm install
27
+ npm run build
29
28
  ```
30
29
 
31
- ### 3. Add to MCP-Supported Software
32
-
33
- #### Claude Desktop
30
+ ## Configuration
34
31
 
35
32
  Add to your `claude_desktop_config.json`:
36
33
 
@@ -41,10 +38,10 @@ Add to your `claude_desktop_config.json`:
41
38
  {
42
39
  "mcpServers": {
43
40
  "email": {
44
- "command": "node",
45
- "args": ["/absolute/path/to/email-smtp-imap-mcp/build/index.js"],
41
+ "command": "npx",
42
+ "args": ["-y", "email-smtp-imap-mcp"],
46
43
  "env": {
47
- "EMAIL_ACCOUNTS_JSON": "{\"icloud\":{\"smtp\":{\"host\":\"smtp.mail.me.com\",\"port\":587,\"user\":\"your@icloud.com\",\"password\":\"your-app-password\"},\"imap\":{\"host\":\"imap.mail.me.com\",\"port\":993},\"default_from_name\":\"Your Name\",\"sender_emails\":[\"your@icloud.com\"]}}",
44
+ "EMAIL_ACCOUNTS_JSON": "{\"icloud\":{\"smtp\":{\"host\":\"smtp.mail.me.com\",\"port\":587,\"user\":\"your@icloud.com\",\"password\":\"your-app-password\"},\"imap\":{\"host\":\"imap.mail.me.com\",\"port\":993},\"default_from_name\":\"Your Name\",\"sender_emails\":[\"your@icloud.com\",\"alias@domain.com\"]}}",
48
45
  "DEFAULT_EMAIL_ACCOUNT": "icloud"
49
46
  }
50
47
  }
@@ -52,9 +49,41 @@ Add to your `claude_desktop_config.json`:
52
49
  }
53
50
  ```
54
51
 
55
- **Note**: Replace `/absolute/path/to/email-smtp-imap-mcp` with your actual installation path. You can also use a `.env` file instead of inline env config.
52
+ **Replace** `your@icloud.com`, `your-app-password`, and `Your Name` with your actual credentials.
53
+
54
+ ### Email Provider Settings
55
+
56
+ <details>
57
+ <summary>📧 iCloud Mail</summary>
58
+
59
+ ```json
60
+ "EMAIL_ACCOUNTS_JSON": "{\"icloud\":{\"smtp\":{\"host\":\"smtp.mail.me.com\",\"port\":587,\"user\":\"your@icloud.com\",\"password\":\"app-specific-password\"},\"imap\":{\"host\":\"imap.mail.me.com\",\"port\":993},\"default_from_name\":\"Your Name\",\"sender_emails\":[\"your@icloud.com\"]}}"
61
+ ```
62
+
63
+ **Note**: Use [app-specific password](https://support.apple.com/en-us/102654), not your iCloud password.
64
+ </details>
65
+
66
+ <details>
67
+ <summary>📧 Gmail</summary>
68
+
69
+ ```json
70
+ "EMAIL_ACCOUNTS_JSON": "{\"gmail\":{\"smtp\":{\"host\":\"smtp.gmail.com\",\"port\":587,\"user\":\"your@gmail.com\",\"password\":\"app-password\"},\"imap\":{\"host\":\"imap.gmail.com\",\"port\":993},\"default_from_name\":\"Your Name\",\"sender_emails\":[\"your@gmail.com\"]}}"
71
+ ```
72
+
73
+ **Note**: Use [app password](https://support.google.com/accounts/answer/185833), not your Google password.
74
+ </details>
75
+
76
+ <details>
77
+ <summary>📧 Outlook/Office 365</summary>
78
+
79
+ ```json
80
+ "EMAIL_ACCOUNTS_JSON": "{\"outlook\":{\"smtp\":{\"host\":\"smtp-mail.outlook.com\",\"port\":587,\"user\":\"your@outlook.com\",\"password\":\"your-password\"},\"imap\":{\"host\":\"outlook.office365.com\",\"port\":993},\"default_from_name\":\"Your Name\",\"sender_emails\":[\"your@outlook.com\"]}}"
81
+ ```
82
+ </details>
83
+
84
+ ---
56
85
 
57
- Restart Claude Desktop to load the MCP server.
86
+ **⚠️ Important**: Restart Claude Desktop after adding configuration.
58
87
 
59
88
  ## 5 Tools
60
89
 
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "email-smtp-imap-mcp",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "Email MCP Server with SMTP and IMAP support - simple, clean, and flexible",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",
7
7
  "type": "module",
8
8
  "bin": {
9
- "email-mcp-server": "build/index.js"
9
+ "email-smtp-imap-mcp": "build/index.js"
10
10
  },
11
11
  "files": [
12
12
  "build/",