shipmail-cli 0.6.2 → 0.6.4

package/README.md

@@ -98,6 +98,7 @@ shipmail mailboxes sandbox-inbound mbx_123 --from customer@example.com --subject
 
 # Read inbound mail
 shipmail inbox list 550e8400-e29b-41d4-a716-446655440000 --folder-role inbox --after 2025-07-20T00:00:00Z --limit 25
+shipmail inbox list 550e8400-e29b-41d4-a716-446655440000 --from billing@vendor.example --subject invoice --has-attachment
 shipmail inbox message 550e8400-e29b-41d4-a716-446655440000 eml_123
 shipmail inbox threads 550e8400-e29b-41d4-a716-446655440000 --attention-state needs_reply --after 2025-07-20T00:00:00Z --limit 50
 shipmail inbox thread 550e8400-e29b-41d4-a716-446655440000 thr_123
@@ -137,7 +138,11 @@ shipmail newsletter-assets register-url https://cdn.shipmail.to/newsletter-image
 # Manage webhooks
 shipmail webhooks create \
   --url https://example.com/shipmail/webhook \
-  --events message.received,message.bounced
+  --events message.received,message.bounced \
+  --authorization "Bearer your-endpoint-key"
+shipmail webhooks update whk_123 --clear-authorization
+shipmail webhooks update whk_123 --standard-webhooks-secret "whsec_..."
+shipmail webhooks update whk_123 --clear-standard-webhooks-secret
 shipmail webhooks deliveries whk_123 --status failed
 shipmail webhooks replay-delivery whk_123 dlv_123 --idempotency-key replay-123
 ```
@@ -173,7 +178,7 @@ Use repeatable `--header "Name: value"` flags for request headers. Use `--output
 - `messages send|list|analytics|get|reply` (test keys also support `--sandbox-outcome`)
 - `scheduled-messages list|get|update|cancel`
 - `mailboxes sandbox-inbound`
-- `webhooks list|create|test|deliveries|replay-delivery`
+- `webhooks list|create|update|test|deliveries|replay-delivery`
 - `suppressions list|remove`
 - `audiences list|create|get|update|delete`
 - `audiences feed get|update|rotate|revoke`

package/dist/cli.js

@@ -649,7 +649,7 @@ async function login(options) {
 }
 
 // src/version.ts
-var VERSION = "0.6.2";
+var VERSION = "0.6.4";
 
 // src/cli.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1035,6 +1035,7 @@ async function newsletterCreateParams(options) {
   const feed_entry_url = getString(options, "feed-entry-url");
   const styling_mode = parseStylingMode(options);
   const track_engagement = getBoolean(options, "track-engagement");
+  const add_utm_tags = getBoolean(options, "add-utm-tags");
   const preview_text = getString(options, "preview-text");
   return {
     audience_id,
@@ -1049,7 +1050,8 @@ async function newsletterCreateParams(options) {
     ...archive_visibility !== void 0 ? { archive_visibility } : {},
     ...feed_entry_url !== void 0 ? { feed_entry_url } : {},
     ...styling_mode !== void 0 ? { styling_mode } : {},
-    ...track_engagement !== void 0 ? { track_engagement } : {}
+    ...track_engagement !== void 0 ? { track_engagement } : {},
+    ...add_utm_tags !== void 0 ? { add_utm_tags } : {}
   };
 }
 async function newsletterUpdateParams(options) {
@@ -1063,6 +1065,7 @@ async function newsletterUpdateParams(options) {
   const feed_entry_url = getString(options, "feed-entry-url");
   const styling_mode = parseStylingMode(options);
   const track_engagement = getBoolean(options, "track-engagement");
+  const add_utm_tags = getBoolean(options, "add-utm-tags");
   const blocksInput = getString(options, "blocks");
   const bodyHtmlInput = getString(options, "body-html");
   const bodyTextInput = getString(options, "body-text");
@@ -1082,7 +1085,8 @@ async function newsletterUpdateParams(options) {
     ...archive_visibility !== void 0 ? { archive_visibility } : {},
     ...feed_entry_url !== void 0 ? { feed_entry_url } : {},
     ...styling_mode !== void 0 ? { styling_mode } : {},
-    ...track_engagement !== void 0 ? { track_engagement } : {}
+    ...track_engagement !== void 0 ? { track_engagement } : {},
+    ...add_utm_tags !== void 0 ? { add_utm_tags } : {}
   };
   if (Object.keys(params).length === 0) {
     throw new CliUsageError("Provide at least one field to update.");
@@ -1202,7 +1206,7 @@ Usage:
   shipmail mailboxes sandbox-inbound <id> --from sender@example.com --subject "Test" (--text "Hello" | --html "<p>Hello</p>") [--to support@example.com]
   shipmail members list [--limit 25] [--cursor cur]
   shipmail members get <id>
-  shipmail inbox list <mailbox-id> [--folder-role inbox] [--search text] [--after ISO] [--before ISO] [--limit 25] [--cursor cur]
+  shipmail inbox list <mailbox-id> [--folder-role inbox] [--search text] [--from text] [--to text] [--subject text] [--has-attachment [true|false]] [--after ISO] [--before ISO] [--limit 25] [--cursor cur]
   shipmail inbox message <mailbox-id> <message-id>
   shipmail inbox threads <mailbox-id> [--attention-state needs_reply] [--after ISO] [--before ISO] [--limit 25] [--cursor cur]
   shipmail inbox thread <mailbox-id> <thread-id>
@@ -1227,7 +1231,8 @@ Usage:
   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 create --url https://example.com/hook --events message.received,message.bounced [--authorization "Bearer key"] [--standard-webhooks-secret whsec_...] [--include-reply-text] [--authenticated-senders-only] [--allowed-sender jane@customer.com --allowed-sender customer.com]
+  shipmail webhooks update <webhook-id> [--url https://example.com/hook] [--events message.received] [--description text] [--active true|false] [--authorization "Bearer key" | --clear-authorization] [--standard-webhooks-secret whsec_... | --clear-standard-webhooks-secret] [--include-reply-text true|false] [--authenticated-senders-only true|false] [--allowed-sender customer.com ... | --clear-allowed-senders]
   shipmail webhooks replay-delivery <webhook-id> <delivery-id> [--idempotency-key key]
   shipmail suppressions list
   shipmail suppressions remove <email>
@@ -1237,8 +1242,8 @@ Usage:
     --name "July changelog" \\
     --subject "What shipped in July" \\
     --blocks @blocks.json \\
-    [--feed-entry-url https://example.com/post] [--styling-mode styled|plain] [--track-engagement true|false]
-  shipmail newsletters update nws_789 --subject "Updated subject" --blocks @blocks-v2.json [--feed-entry-url https://example.com/post] [--styling-mode styled|plain] [--track-engagement true|false]
+    [--feed-entry-url https://example.com/post] [--styling-mode styled|plain] [--track-engagement true|false] [--add-utm-tags true|false]
+  shipmail newsletters update nws_789 --subject "Updated subject" --blocks @blocks-v2.json [--feed-entry-url https://example.com/post] [--styling-mode styled|plain] [--track-engagement true|false] [--add-utm-tags true|false]
   shipmail newsletters preview <id>
   shipmail newsletters preflight <id>
   shipmail newsletters test-send <id> --recipient-email owner@example.com
@@ -1296,6 +1301,7 @@ Newsletter styling:
 
 Newsletter tracking:
   --track-engagement <true|false>  Track opens and clicks for this issue. Off by default. Changes only while the issue is a draft or scheduled for later.
+  --add-utm-tags <true|false>  Add utm_source, utm_medium and utm_campaign to the issue's links in the email and the feed. Off by default. Changes only while the issue is a draft or scheduled for later.
 
 Newsletter block prose:
   Paragraph, quote, callout, list-item, and column bodies accept bare text or sanitized inline HTML. Use <p> and <br> for line breaks.
@@ -1346,11 +1352,22 @@ function requirePositional(positional, index, label) {
   if (!value) throw new CliUsageError(`Missing ${label}.`);
   return value;
 }
+function inboxTextFilters(options) {
+  const from = getString(options, "from");
+  const to = getString(options, "to");
+  const subject = getString(options, "subject");
+  return {
+    ...from ? { from } : {},
+    ...to ? { to } : {},
+    ...subject ? { subject } : {}
+  };
+}
 function inboxListParams(options) {
   const params = {};
   const folderId = getString(options, "folder-id");
   const folderRole = getString(options, "folder-role");
   const searchText = getString(options, "search");
+  const hasAttachment = getBoolean(options, "has-attachment");
   const cursor = getString(options, "cursor");
   const after = getString(options, "after");
   const before = getString(options, "before");
@@ -1360,6 +1377,8 @@ function inboxListParams(options) {
   if (folderId) params.folder_id = folderId;
   if (folderRole) params.folder_role = folderRole;
   if (searchText) params.search_text = searchText;
+  Object.assign(params, inboxTextFilters(options));
+  if (hasAttachment !== void 0) params.has_attachment = hasAttachment;
   if (cursor) params.cursor = cursor;
   if (after) params.after = after;
   if (before) params.before = before;
@@ -1380,6 +1399,59 @@ function webhookEvents(options) {
   }
   return events;
 }
+function webhookWriteOnlyOption(options, name) {
+  const value = optionValue(options, name);
+  if (value === void 0) return void 0;
+  if (typeof value === "boolean") throw new CliUsageError(`Missing value for --${name}.`);
+  return getString(options, name);
+}
+function webhookWriteOnlyUpdate(options, name) {
+  const value = webhookWriteOnlyOption(options, name);
+  const clear = getBoolean(options, `clear-${name}`) === true;
+  if (value !== void 0 && clear) {
+    throw new CliUsageError(`Use --${name} or --clear-${name}, not both.`);
+  }
+  return clear ? null : value;
+}
+function webhookAllowedSenders(options) {
+  const value = optionValue(options, "allowed-sender");
+  if (value === void 0) return void 0;
+  if (typeof value === "boolean") throw new CliUsageError("Missing value for --allowed-sender.");
+  return getStringList(options, "allowed-sender");
+}
+function webhookAllowedSendersUpdate(options) {
+  const senders = webhookAllowedSenders(options);
+  const clear = getBoolean(options, "clear-allowed-senders") === true;
+  if (senders !== void 0 && clear) {
+    throw new CliUsageError("Use --allowed-sender or --clear-allowed-senders, not both.");
+  }
+  return clear ? null : senders;
+}
+function webhookUpdateParams(options) {
+  const authorization = webhookWriteOnlyUpdate(options, "authorization");
+  const standardWebhooksSecret = webhookWriteOnlyUpdate(options, "standard-webhooks-secret");
+  const url = getString(options, "url");
+  const description = getString(options, "description");
+  const active = getBoolean(options, "active");
+  const includeReplyText = getBoolean(options, "include-reply-text");
+  const authenticatedSendersOnly = getBoolean(options, "authenticated-senders-only");
+  const allowedSenders = webhookAllowedSendersUpdate(options);
+  const params = {
+    ...url !== void 0 ? { url } : {},
+    ...optionValue(options, "events") !== void 0 ? { events: webhookEvents(options) } : {},
+    ...description !== void 0 ? { description } : {},
+    ...active !== void 0 ? { active } : {},
+    ...authorization !== void 0 ? { authorization } : {},
+    ...standardWebhooksSecret !== void 0 ? { standard_webhooks_secret: standardWebhooksSecret } : {},
+    ...includeReplyText !== void 0 ? { include_reply_text: includeReplyText } : {},
+    ...authenticatedSendersOnly !== void 0 ? { authenticated_senders_only: authenticatedSendersOnly } : {},
+    ...allowedSenders !== void 0 ? { allowed_senders: allowedSenders } : {}
+  };
+  if (Object.keys(params).length === 0) {
+    throw new CliUsageError("Nothing to update. Pass at least one webhook option.");
+  }
+  return params;
+}
 function webhookDeliveryParams(options) {
   const status = getString(options, "status");
   const eventType = getString(options, "event-type");
@@ -2170,16 +2242,34 @@ async function runWebhooks(client, parsed, out) {
   }
   if (subcommand === "create") {
     const description = getString(parsed.options, "description");
+    const authorization = webhookWriteOnlyOption(parsed.options, "authorization");
+    const standardWebhooksSecret = webhookWriteOnlyOption(
+      parsed.options,
+      "standard-webhooks-secret"
+    );
+    const includeReplyText = getBoolean(parsed.options, "include-reply-text");
+    const authenticatedSendersOnly = getBoolean(parsed.options, "authenticated-senders-only");
+    const allowedSenders = webhookAllowedSenders(parsed.options);
     writeJson(
       out,
       await client.webhooks.create({
         url: getRequiredString(parsed.options, "url"),
         events: webhookEvents(parsed.options),
-        ...description ? { description } : {}
+        ...description ? { description } : {},
+        ...authorization !== void 0 ? { authorization } : {},
+        ...standardWebhooksSecret !== void 0 ? { standard_webhooks_secret: standardWebhooksSecret } : {},
+        ...includeReplyText !== void 0 ? { include_reply_text: includeReplyText } : {},
+        ...authenticatedSendersOnly !== void 0 ? { authenticated_senders_only: authenticatedSendersOnly } : {},
+        ...allowedSenders !== void 0 ? { allowed_senders: allowedSenders } : {}
       })
     );
     return;
   }
+  if (subcommand === "update") {
+    const webhookId = requirePositional(parsed.positional, 2, "webhook id");
+    writeJson(out, await client.webhooks.update(webhookId, webhookUpdateParams(parsed.options)));
+    return;
+  }
   if (subcommand === "test") {
     writeJson(
       out,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipmail-cli",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Official CLI for the Shipmail API",
   "type": "module",
   "bin": {
@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "shipmail": "0.6.3",
+    "shipmail": "0.6.5",
     "zod": "^4.6.5"
   },
   "devDependencies": {