@inboxapi/cli 0.2.2 → 0.2.3

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 (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +63 -10
  3. package/package.json +6 -6
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Shaon Diwakar
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,6 +1,40 @@
1
1
  # InboxAPI CLI
2
2
 
3
- STDIO proxy that bridges the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) over STDIO to the remote [InboxAPI](https://inboxapi.ai) service over Streamable HTTP/SSE. This lets any MCP-compatible client (Claude Desktop, Claude Code, etc.) use InboxAPI's email tools without custom HTTP integration.
3
+ Give your AI agent its own email address. Send, receive, read, search, and reply to emails right from Claude, Codex, Gemini, or any MCP-compatible AI client. No email server to run, no SMTP to configure.
4
+
5
+ **Quick Setup (Claude Code, Gemini CLI, etc.):**
6
+
7
+ Copy and paste this sentence into your agent:
8
+
9
+ ```
10
+ Install the `@inboxapi/cli` npm package globally and then register the `inboxapi` command as an MCP server named `inboxapi`.
11
+ ```
12
+
13
+ ### How it works
14
+
15
+ 1. Install the CLI
16
+ 2. Connect it to your AI client (Claude Desktop, Claude Code, Gemini CLI, etc.)
17
+ 3. Your AI can now use email — no code or API keys needed
18
+
19
+ An account with a unique email address is created automatically on first run. Your AI can then:
20
+
21
+ - **Send emails** to any address
22
+ - **Receive emails** at its own inbox
23
+ - **Reply to** and **forward** emails
24
+ - **Search** emails by keyword
25
+ - **Read full threads** of conversation
26
+
27
+ ## Technical details
28
+
29
+ The CLI acts as a local bridge between your AI client and the [InboxAPI](https://inboxapi.ai) cloud service. It speaks the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) over standard input/output, so any compatible AI client can use it without custom integration.
30
+
31
+ ## Good to know
32
+
33
+ - **This is your agent's personal email** — InboxAPI gives your AI agent its own email address for personal use. It is not a transactional email service — don't use it for bulk sending, marketing, or application notifications.
34
+ - **Weekly send limit** — Each account can send to up to five unique email addresses per week. This resets weekly.
35
+ - **Check your spam folder** — Emails from InboxAPI may land in your junk or spam folder. If you're not seeing messages, check there first.
36
+ - **No attachments yet** — Attachment support is not available right now, but it's coming soon.
37
+ - **No rich text yet** — Emails are sent as plain text only. Rich text (HTML) support is coming soon.
4
38
 
5
39
  ## Installation
6
40
 
@@ -18,8 +52,9 @@ Prebuilt binaries are included for:
18
52
 
19
53
  ## Getting Started
20
54
 
55
+ Just start the proxy — an account is created automatically on first run
56
+
21
57
  ```bash
22
- # Just start the proxy — an account is created automatically on first run
23
58
  inboxapi proxy
24
59
  ```
25
60
 
@@ -80,33 +115,51 @@ InboxAPI CLI works as an MCP STDIO transport. Point your MCP client at the `inbo
80
115
 
81
116
  **Claude Code:**
82
117
 
118
+ Add to current project:
119
+
83
120
  ```bash
84
- # Add to current project
85
121
  claude mcp add inboxapi inboxapi
122
+ ```
86
123
 
87
- # Add globally (available in all projects)
124
+ Add globally (available in all projects):
125
+
126
+ ```bash
88
127
  claude mcp add inboxapi inboxapi -s user
89
128
  ```
90
129
 
91
130
  **Gemini CLI:**
92
131
 
132
+ Add to current project:
133
+
93
134
  ```bash
94
- # Add to current project
95
135
  gemini mcp add inboxapi inboxapi
136
+ ```
137
+
138
+ Add system-wide (available in all directories):
96
139
 
97
- # Add system-wide (available in all directories)
140
+ ```bash
98
141
  gemini mcp add inboxapi inboxapi --scope user
99
142
  ```
100
143
 
144
+ **Codex CLI:**
145
+
146
+ ```bash
147
+ codex mcp add inboxapi -- inboxapi
148
+ ```
149
+
101
150
  ## Development
102
151
 
103
152
  ```bash
104
- cargo build # Build debug binary
153
+ cargo build # Build debug binary
105
154
  cargo build --release # Build release binary
106
- cargo test # Run tests
107
- cargo fmt # Format code
155
+ cargo test # Run tests
156
+ cargo fmt # Format code
108
157
  ```
109
158
 
110
159
  ## License
111
160
 
112
- MIT
161
+ The source code in this repository is licensed under the [MIT License](LICENSE).
162
+
163
+ ## Disclaimer
164
+
165
+ The InboxAPI service is provided as-is, with no guarantees or warranties of any kind. We reserve all rights regarding how the service is operated. Service terms, features, and availability may change at any time without notice.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@inboxapi/cli",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "description": "📧 Email for your AI 🤖",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -27,10 +27,10 @@
27
27
  "test": "cargo test"
28
28
  },
29
29
  "optionalDependencies": {
30
- "@inboxapi/cli-darwin-arm64": "0.2.2",
31
- "@inboxapi/cli-darwin-x64": "0.2.2",
32
- "@inboxapi/cli-linux-x64": "0.2.2",
33
- "@inboxapi/cli-linux-arm64": "0.2.2",
34
- "@inboxapi/cli-win32-x64": "0.2.2"
30
+ "@inboxapi/cli-darwin-arm64": "0.2.3",
31
+ "@inboxapi/cli-darwin-x64": "0.2.3",
32
+ "@inboxapi/cli-linux-x64": "0.2.3",
33
+ "@inboxapi/cli-linux-arm64": "0.2.3",
34
+ "@inboxapi/cli-win32-x64": "0.2.3"
35
35
  }
36
36
  }