@bobfrankston/mailx 1.0.4 → 1.0.6

package/README.md

@@ -140,16 +140,67 @@ If `config.json` doesn't exist, settings default to `~/.mailx/settings.jsonc`.
 | Escape | Discard / Clear search |
 | F5 | Sync |
 
+## Installation
+
+```bash
+npm install -g @bobfrankston/mailx
+mailx                              # Starts server + opens browser
+```
+
+Or for development:
+```bash
+git clone https://github.com/BobFrankston/mailx.git
+cd mailx
+npm install
+npm start                          # Starts server with --watch (auto-restart on changes)
+```
+
+The native WebView2 app (optional):
+```bash
+launch.ps1                         # Builds and runs the Rust launcher
+launch.ps1 -restart                # Kill existing server first
+```
+
 ## Data Storage
 
-| File | Location | Purpose |
-|------|----------|---------|
-| config.json | ~/.mailx/ | Points to settings file |
-| settings.jsonc | OneDrive or ~/.mailx/ | Accounts, prefs (shared across machines) |
-| mailx.db | ~/.mailx/ | SQLite — headers, contacts, sync state |
-| mailxstore/ | ~/.mailx/ | Cached message bodies (.eml) |
-| window.json | ~/.mailx/ | Window position (per machine) |
-| mailx.log | project dir | Server log with timestamps |
+All data lives in `~/.mailx/` (e.g., `C:\Users\You\.mailx\`):
+
+| File | Shared? | Purpose |
+|------|---------|---------|
+| config.json | No | Points to shared settings dir + local overrides |
+| accounts.jsonc | Yes | IMAP/SMTP account configs |
+| preferences.jsonc | Yes | UI, sync, font settings |
+| allowlist.jsonc | Yes | Remote content sender/domain allow-list |
+| settings.jsonc | Yes | Legacy combined settings (still supported) |
+| mailx.db | No | SQLite — headers, contacts, sync state |
+| mailxstore/ | No | Cached message bodies (.eml per message) |
+| window.json | No | Window position (per machine) |
+| mailx-YYYY-MM-DD.log | No | Server log (auto-deleted after 7 days) |
+
+**Shared** files can live on OneDrive/Dropbox — `config.json` points to the shared directory. **Local** files stay on the machine.
+
+### Safe to Delete
+
+- **mailxstore/** — cached bodies, re-downloaded automatically during sync or on demand. Delete to reclaim space or reset the cache.
+- **mailx.db** — re-created on next startup, triggers full re-sync of all messages within the history window.
+- **mailx-*.log** — auto-cleaned after 7 days. Safe to delete anytime.
+- **window.json** — resets window position to default 1280×800.
+
+### config.json
+
+```json
+{
+  "sharedDir": "C:/Users/You/OneDrive/home/.mailx",
+  "storePath": "C:/Users/You/.mailx/mailxstore",
+  "historyDays": 90
+}
+```
+
+- **sharedDir** — directory containing shared settings files (accounts, preferences, allowlist)
+- **storePath** — where cached .eml files are stored
+- **historyDays** — per-machine override for sync history (shared default is 30)
+
+If `config.json` doesn't exist, all settings default to `~/.mailx/`.
 
 ## Architecture
 
@@ -159,3 +210,4 @@ If `config.json` doesn't exist, settings default to `~/.mailx/settings.jsonc`.
 - **Outbox** — queued in IMAP Outbox folder with multi-machine interlock via flags
 - **Remote content blocking** — HTML sanitized server-side, CSP in iframe, per-sender/domain allow-list
 - **Search** — SQLite FTS5 full-text index with qualifiers
+- **Unified mode** — `mailx` command runs server in-process (no separate server). Use `--server` for standalone server mode.

package/bin/mailx.js

@@ -9,12 +9,9 @@
  *   mailx --external         Bind to all interfaces (default: localhost only)
  */
 
-import { fileURLToPath } from "node:url";
-import path from "node:path";
 import net from "node:net";
 
 const PORT = 9333;
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const args = process.argv.slice(2);
 
 function isPortInUse(port) {
@@ -48,17 +45,14 @@ async function main() {
         return;
     }
 
-    // Start server in-process (unified mode)
     console.log(`Starting mailx on port ${PORT}...`);
 
-    // Pass --external to server if requested
     if (args.includes("--external")) process.argv.push("--external");
 
-    // Import and start the server directly — no subprocess
-    await import(path.join(__dirname, "..", "packages", "mailx-server", "index.js"));
+    // Import server directly — relative path, in-process
+    await import("../packages/mailx-server/index.js");
 
     if (!noBrowser) {
-        // Wait a moment for server to be ready
         for (let i = 0; i < 30; i++) {
             await new Promise(r => setTimeout(r, 200));
             if (await isPortInUse(PORT)) break;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/mailx",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Local-first email client with IMAP sync and standalone native app",
   "type": "module",
   "main": "bin/mailx.js",