shipmail-cli 0.2.1 → 0.3.0

package/README.md

@@ -56,10 +56,21 @@ shipmail messages send --mailbox-id mbx_123 --to user@example.com --subject "Tes
 shipmail mailboxes sandbox-inbound mbx_123 --from customer@example.com --subject "Re: Test" --text "Fake inbound reply"
 
 # Read inbound mail
-shipmail inbox list mbx_123 --folder-role inbox --limit 25
-shipmail inbox thread mbx_123 thr_123
-shipmail inbox reply-message mbx_123 eml_123 --to user@example.com --text "Thanks"
-shipmail inbox reply-thread mbx_123 thr_123 --to user@example.com --text "Following up"
+shipmail inbox list 550e8400-e29b-41d4-a716-446655440000 --folder-role inbox --after 2025-07-20T00:00:00Z --limit 25
+shipmail inbox message 550e8400-e29b-41d4-a716-446655440000 eml_123
+shipmail inbox threads 550e8400-e29b-41d4-a716-446655440000 --reply-state needs_reply --after 2025-07-20T00:00:00Z --limit 50
+shipmail inbox thread 550e8400-e29b-41d4-a716-446655440000 thr_123
+shipmail inbox draft 550e8400-e29b-41d4-a716-446655440000 thr_123 --expected-reply-version 7 --text "Thanks for the note"
+# Apply your approval policy; stale drafts fail with 409 without delivery.
+shipmail inbox send-draft 550e8400-e29b-41d4-a716-446655440000 thr_123 drf_123
+shipmail inbox thread-state 550e8400-e29b-41d4-a716-446655440000 thr_123 --reply-state resolved --expected-reply-version 8
+shipmail inbox reply-message 550e8400-e29b-41d4-a716-446655440000 eml_123 --to user@example.com --text "Thanks"
+shipmail inbox reply-thread 550e8400-e29b-41d4-a716-446655440000 thr_123 --to user@example.com --text "Following up"
+
+# Frozen historical scan, retained for 30 days (repeat --mailbox-id for more mailboxes)
+shipmail reply-scans create --mailbox-id 550e8400-e29b-41d4-a716-446655440000 --after 2025-07-20T00:00:00Z
+shipmail reply-scans status rsc_123
+shipmail reply-scans results rsc_123 --limit 100
 
 # Find newsletter sending domain IDs, then create a draft with blocks
 shipmail newsletter-domains list
@@ -106,9 +117,6 @@ shipmail api GET /domains
 
 shipmail api PATCH /mailboxes/mbx_123/spam-filter \
   --data '{"threshold":6}'
-
-shipmail api PUT /mailboxes/mbx_123/rules \
-  --data @rules.json
 ```
 
 Use repeatable `--header "Name: value"` flags for request headers. Use `--output path` to write non-JSON responses, such as attachment downloads.
@@ -118,8 +126,9 @@ Use repeatable `--header "Name: value"` flags for request headers. Use `--output
 - `status`
 - `api <METHOD> <PATH>`
 - `domains list|search|create|get|verify|delete`
-- `mailboxes list|create|get|suspend|resume|forwarding|forwarding-add|forwarding-remove|app-passwords|folders|identities|rules`
-- `inbox list|thread|reply-message|reply-thread|update|move`
+- `mailboxes list|create|get|suspend|resume|forwarding|forwarding-add|forwarding-remove|app-passwords|folders|identities`
+- `inbox list|message|threads|thread|thread-state|draft|send-draft|reply-message|reply-thread|update|move`
+- `reply-scans create|status|results`
 - `messages send|list|get|reply` (test keys also support `--sandbox-outcome`)
 - `mailboxes sandbox-inbound`
 - `webhooks list|create|test|deliveries|replay-delivery`

package/dist/cli.js

@@ -13,7 +13,7 @@ import {
 } from "shipmail";
 
 // src/version.ts
-var VERSION = "0.2.1";
+var VERSION = "0.3.0";
 
 // src/cli.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -335,13 +335,17 @@ Usage:
   shipmail mailboxes app-passwords revoke <id> <app-password-id>
   shipmail mailboxes folders <id>
   shipmail mailboxes identities <id>
-  shipmail mailboxes rules <id>
   shipmail mailboxes forwarding <id>
   shipmail mailboxes forwarding-add <id> --destination owner@example.com
   shipmail mailboxes forwarding-remove <id> <forwarding-id>
   shipmail mailboxes sandbox-inbound <id> --from sender@example.com --subject "Test" (--text "Hello" | --html "<p>Hello</p>") [--to support@example.com]
-  shipmail inbox list <mailbox-id> [--folder-role inbox] [--limit 25]
+  shipmail inbox list <mailbox-id> [--folder-role inbox] [--after ISO] [--before ISO] [--limit 25] [--cursor cur]
+  shipmail inbox message <mailbox-id> <message-id>
+  shipmail inbox threads <mailbox-id> [--reply-state needs_reply] [--after ISO] [--before ISO] [--limit 25] [--cursor cur]
   shipmail inbox thread <mailbox-id> <thread-id>
+  shipmail inbox thread-state <mailbox-id> <thread-id> --reply-state resolved --expected-reply-version 3
+  shipmail inbox draft <mailbox-id> <thread-id> --expected-reply-version 3 (--text "Hello" | --html "<p>Hello</p>") [--reply-mode reply_all]
+  shipmail inbox send-draft <mailbox-id> <thread-id> <draft-id>
   shipmail inbox reply-message <mailbox-id> <message-id> --to user@example.com (--text "Hello" | --html "<p>Hello</p>")
   shipmail inbox reply-thread <mailbox-id> <thread-id> --to user@example.com (--text "Hello" | --html "<p>Hello</p>")
   shipmail inbox update <mailbox-id> <message-id> [--read true] [--starred false]
@@ -350,6 +354,9 @@ Usage:
   shipmail messages list (--mailbox-id mbx | --client-reference crm-123) [--limit 25] [--cursor cur]
   shipmail messages get <message-id>
   shipmail messages reply <message-id> --to user@example.com (--text "Hello" | --html "<p>Hello</p>") [--client-reference crm-reply-123]
+  shipmail reply-scans create --mailbox-id mbx --after ISO [--before ISO]
+  shipmail reply-scans status <scan-id>
+  shipmail reply-scans results <scan-id> [--limit 25] [--cursor cur]
   shipmail webhooks list
   shipmail webhooks create --url https://example.com/hook --events message.received,message.bounced
   shipmail webhooks replay-delivery <webhook-id> <delivery-id> [--idempotency-key key]
@@ -434,14 +441,18 @@ function inboxListParams(options) {
   const folderId = getString(options, "folder-id");
   const folderRole = getString(options, "folder-role");
   const searchText = getString(options, "search");
-  const position = getNumber(options, "position");
+  const cursor = getString(options, "cursor");
+  const after = getString(options, "after");
+  const before = getString(options, "before");
   const limit = getNumber(options, "limit");
   const hasKeyword = getString(options, "has-keyword");
   const notKeyword = getString(options, "not-keyword");
   if (folderId) params.folder_id = folderId;
   if (folderRole) params.folder_role = folderRole;
   if (searchText) params.search_text = searchText;
-  if (position !== void 0) params.position = position;
+  if (cursor) params.cursor = cursor;
+  if (after) params.after = after;
+  if (before) params.before = before;
   if (limit !== void 0) params.limit = limit;
   if (hasKeyword) params.has_keyword = hasKeyword;
   if (notKeyword) params.not_keyword = notKeyword;
@@ -724,13 +735,6 @@ async function runMailboxes(client, parsed, out) {
     );
     return;
   }
-  if (subcommand === "rules") {
-    writeJson(
-      out,
-      await client.mailboxes.getRules(requirePositional(parsed.positional, 2, "mailbox id"))
-    );
-    return;
-  }
   if (subcommand === "forwarding") {
     writeJson(
       out,
@@ -807,6 +811,92 @@ async function runInbox(client, parsed, out) {
     );
     return;
   }
+  if (subcommand === "message") {
+    writeJson(
+      out,
+      await client.mailboxes.getInboxMessage(
+        requirePositional(parsed.positional, 2, "mailbox id"),
+        requirePositional(parsed.positional, 3, "message id")
+      )
+    );
+    return;
+  }
+  if (subcommand === "threads") {
+    const replyState = getString(parsed.options, "reply-state");
+    const sortBy = getString(parsed.options, "sort-by");
+    const order = getString(parsed.options, "order");
+    writeJson(
+      out,
+      await client.mailboxes.listInboxThreads(
+        requirePositional(parsed.positional, 2, "mailbox id"),
+        {
+          ...replyState ? {
+            reply_state: replyState
+          } : {},
+          ...sortBy ? { sort_by: sortBy } : {},
+          ...order ? { order } : {},
+          ...getString(parsed.options, "after") ? { after: getString(parsed.options, "after") } : {},
+          ...getString(parsed.options, "before") ? { before: getString(parsed.options, "before") } : {},
+          ...getString(parsed.options, "cursor") ? { cursor: getString(parsed.options, "cursor") } : {},
+          ...getNumber(parsed.options, "limit") !== void 0 ? { limit: getNumber(parsed.options, "limit") } : {}
+        }
+      )
+    );
+    return;
+  }
+  if (subcommand === "thread-state") {
+    const replyState = getString(parsed.options, "reply-state");
+    const expectedReplyVersion = getNumber(parsed.options, "expected-reply-version");
+    if (!replyState || expectedReplyVersion === void 0) {
+      throw new CliUsageError("Provide --reply-state and --expected-reply-version.");
+    }
+    writeJson(
+      out,
+      await client.mailboxes.updateInboxThreadReplyState(
+        requirePositional(parsed.positional, 2, "mailbox id"),
+        requirePositional(parsed.positional, 3, "thread id"),
+        {
+          reply_state: replyState,
+          expected_reply_version: expectedReplyVersion
+        }
+      )
+    );
+    return;
+  }
+  if (subcommand === "draft") {
+    const expectedReplyVersion = getNumber(parsed.options, "expected-reply-version");
+    if (expectedReplyVersion === void 0) {
+      throw new CliUsageError("Provide --expected-reply-version.");
+    }
+    const text = await readTextInput(getString(parsed.options, "text"));
+    const html = await readTextInput(getString(parsed.options, "html"));
+    if (!text && !html) throw new CliUsageError("Provide --text or --html.");
+    writeJson(
+      out,
+      await client.mailboxes.createInboxReplyDraft(
+        requirePositional(parsed.positional, 2, "mailbox id"),
+        requirePositional(parsed.positional, 3, "thread id"),
+        {
+          expected_reply_version: expectedReplyVersion,
+          ...text ? { text } : {},
+          ...html ? { html } : {},
+          ...getString(parsed.options, "reply-mode") ? { reply_mode: getString(parsed.options, "reply-mode") } : {}
+        }
+      )
+    );
+    return;
+  }
+  if (subcommand === "send-draft") {
+    writeJson(
+      out,
+      await client.mailboxes.sendInboxReplyDraft(
+        requirePositional(parsed.positional, 2, "mailbox id"),
+        requirePositional(parsed.positional, 3, "thread id"),
+        requirePositional(parsed.positional, 4, "draft id")
+      )
+    );
+    return;
+  }
   if (subcommand === "reply-message") {
     writeJson(
       out,
@@ -870,6 +960,41 @@ async function runInbox(client, parsed, out) {
   }
   throw new CliUsageError("Unknown inbox command.");
 }
+async function runReplyScans(client, parsed, out) {
+  const subcommand = parsed.positional[1];
+  if (subcommand === "create") {
+    const mailboxIds = getStringList(parsed.options, "mailbox-id");
+    const after = getString(parsed.options, "after");
+    if (mailboxIds.length === 0 || !after) {
+      throw new CliUsageError("Provide --mailbox-id and --after.");
+    }
+    writeJson(
+      out,
+      await client.replyScans.create({
+        mailbox_ids: [...mailboxIds],
+        after,
+        ...getString(parsed.options, "before") ? { before: getString(parsed.options, "before") } : {}
+      })
+    );
+    return;
+  }
+  const scanId = requirePositional(parsed.positional, 2, "scan id");
+  if (subcommand === "status") {
+    writeJson(out, await client.replyScans.get(scanId));
+    return;
+  }
+  if (subcommand === "results") {
+    writeJson(
+      out,
+      await client.replyScans.listResults(scanId, {
+        ...getString(parsed.options, "cursor") ? { cursor: getString(parsed.options, "cursor") } : {},
+        ...getNumber(parsed.options, "limit") !== void 0 ? { limit: getNumber(parsed.options, "limit") } : {}
+      })
+    );
+    return;
+  }
+  throw new CliUsageError("Unknown reply-scans command.");
+}
 async function runMessages(client, parsed, out) {
   const subcommand = parsed.positional[1];
   if (subcommand === "send") {
@@ -1667,6 +1792,7 @@ async function runCli(argv, options = {}) {
     else if (command === "mailboxes") await runMailboxes(client, parsed, out);
     else if (command === "inbox") await runInbox(client, parsed, out);
     else if (command === "messages") await runMessages(client, parsed, out);
+    else if (command === "reply-scans") await runReplyScans(client, parsed, out);
     else if (command === "webhooks") await runWebhooks(client, parsed, out);
     else if (command === "suppressions") await runSuppressions(client, parsed, out);
     else if (command === "newsletters") await runNewsletters(client, parsed, out);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipmail-cli",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Official CLI for the ShipMail API",
   "type": "module",
   "bin": {
@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "shipmail": "0.2.2"
+    "shipmail": "0.3.0"
   },
   "devDependencies": {
     "tsup": "^8.4.0",