shipmail 0.4.1 → 0.4.3

package/README.md

@@ -160,6 +160,22 @@ const folder = await shipmail.mailboxes.createFolder("mbx_...", {
 await shipmail.mailboxes.updateFolder("mbx_...", folder.id, { name: "VIP Clients" });
 await shipmail.mailboxes.deleteFolder("mbx_...", folder.id);
 const identities = await shipmail.mailboxes.listIdentities("mbx_...");
+const currentRules = await shipmail.mailboxes.getRules("mbx_...");
+const updatedRules = await shipmail.mailboxes.updateRules("mbx_...", {
+  rules: [
+    ...currentRules.rules,
+    {
+      id: crypto.randomUUID(),
+      name: "Flag invoices",
+      enabled: true,
+      position: currentRules.rules.length,
+      match_mode: "all",
+      stop: false,
+      conditions: [{ type: "subject_contains", value: "invoice" }],
+      actions: [{ type: "star" }, { type: "send_webhook" }],
+    },
+  ],
+});
 await shipmail.mailboxes.updateSpamFilter("mbx_...", { threshold: 8 });
 await shipmail.mailboxes.delete("mbx_...");
 
@@ -357,6 +373,7 @@ message.delivered
 message.bounced
 message.complained
 thread.needs_reply
+mailbox.rule_matched
 domain.verified
 domain.verification_failed
 domain.degraded

package/dist/api-key-scopes.cjs

@@ -18,6 +18,8 @@ var API_KEY_SCOPES = [
   "mailbox_credentials:write",
   "mailbox_forwarding:read",
   "mailbox_forwarding:write",
+  "mailbox_rules:read",
+  "mailbox_rules:write",
   "messages:read",
   "messages:write",
   "drafts:write",
@@ -52,6 +54,8 @@ var API_KEY_SCOPE_DESCRIPTIONS = {
   "mailbox_credentials:write": "Create and revoke app passwords for allowed mailboxes.",
   "mailbox_forwarding:read": "List forwarding destinations for allowed mailboxes.",
   "mailbox_forwarding:write": "Create and remove forwarding destinations for allowed mailboxes.",
+  "mailbox_rules:read": "List deterministic server-side rules for allowed mailboxes.",
+  "mailbox_rules:write": "Create, replace, and remove deterministic rules for allowed mailboxes.",
   "messages:read": "List and retrieve messages.",
   "messages:write": "Update, move, delete, and inject sandbox messages.",
   "drafts:write": "Create agent-safe reply drafts with server-derived recipients.",

package/dist/api-key-scopes.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/api-key-scopes.ts"],"names":[],"mappings":";;;AAAO,IAAM,cAAA,GAAiB;AAAA,EAC5B,GAAA;AAAA,EACA,gBAAA;AAAA,EACA,iBAAA;AAAA,EACA,oBAAA;AAAA,EACA,qBAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,kBAAA;AAAA,EACA,iBAAA;AAAA,EACA,0BAAA;AAAA,EACA,2BAAA;AAAA,EACA,yBAAA;AAAA,EACA,0BAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,kBAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,mBAAA;AAAA,EACA,oBAAA;AAAA,EACA,4BAAA;AAAA,EACA,6BAAA;AAAA,EACA,8BAAA;AAAA,EACA,mCAAA;AAAA,EACA;AACF;AAIO,IAAM,0BAAA,GAAoE;AAAA,EAC/E,GAAA,EAAK,qDAAA;AAAA,EACL,gBAAA,EAAkB,+DAAA;AAAA,EAClB,iBAAA,EAAmB,gEAAA;AAAA,EACnB,oBAAA,EAAsB,kCAAA;AAAA,EACtB,qBAAA,EAAuB,2CAAA;AAAA,EACvB,eAAA,EAAiB,0DAAA;AAAA,EACjB,gBAAA,EAAkB,6CAAA;AAAA,EAClB,cAAA,EAAgB,qCAAA;AAAA,EAChB,eAAA,EAAiB,qCAAA;AAAA,EACjB,gBAAA,EAAkB,8BAAA;AAAA,EAClB,kBAAA,EAAoB,8CAAA;AAAA,EACpB,iBAAA,EAAmB,wDAAA;AAAA,EACnB,0BAAA,EAA4B,qDAAA;AAAA,EAC5B,2BAAA,EAA6B,wDAAA;AAAA,EAC7B,yBAAA,EAA2B,qDAAA;AAAA,EAC3B,0BAAA,EAA4B,kEAAA;AAAA,EAC5B,eAAA,EAAiB,6BAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,cAAA,EAAgB,gEAAA;AAAA,EAChB,eAAA,EAAiB,oDAAA;AAAA,EACjB,kBAAA,EAAoB,oDAAA;AAAA,EACpB,mBAAA,EAAqB,iEAAA;AAAA,EACrB,cAAA,EAAgB,4CAAA;AAAA,EAChB,eAAA,EAAiB,wDAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,mBAAA,EAAqB,sCAAA;AAAA,EACrB,oBAAA,EAAsB,6CAAA;AAAA,EACtB,4BAAA,EAA8B,uDAAA;AAAA,EAC9B,6BAAA,EAA+B,uDAAA;AAAA,EAC/B,8BAAA,EAAgC,iEAAA;AAAA,EAChC,mCAAA,EACE,6EAAA;AAAA,EACF,oBAAA,EAAsB;AACxB;AAEO,SAAS,cAAc,KAAA,EAAqC;AACjE,EAAA,OAAO,cAAA,CAAe,IAAA,CAAK,CAAC,KAAA,KAAU,UAAU,KAAK,CAAA;AACvD;AAEO,SAAS,iBAAA,CACd,eACA,aAAA,EACS;AACT,EAAA,IAAI,aAAA,KAAkB,UAAU,OAAO,IAAA;AACvC,EAAA,IAAI,cAAc,UAAA,CAAW,UAAU,GAAG,OAAO,aAAA,CAAc,SAAS,aAAa,CAAA;AACrF,EAAA,OAAO,cAAc,QAAA,CAAS,GAAG,CAAA,IAAK,aAAA,CAAc,SAAS,aAAa,CAAA;AAC5E","file":"api-key-scopes.cjs","sourcesContent":["export const API_KEY_SCOPES = [\n  \"*\",\n  \"audiences:read\",\n  \"audiences:write\",\n  \"booking_pages:read\",\n  \"booking_pages:write\",\n  \"calendar:read\",\n  \"calendar:write\",\n  \"domains:read\",\n  \"domains:write\",\n  \"mailboxes:read\",\n  \"mailboxes:export\",\n  \"mailboxes:write\",\n  \"mailbox_credentials:read\",\n  \"mailbox_credentials:write\",\n  \"mailbox_forwarding:read\",\n  \"mailbox_forwarding:write\",\n  \"messages:read\",\n  \"messages:write\",\n  \"drafts:write\",\n  \"messages:send\",\n  \"newsletters:read\",\n  \"newsletters:write\",\n  \"threads:read\",\n  \"webhooks:read\",\n  \"webhooks:write\",\n  \"suppressions:read\",\n  \"suppressions:write\",\n  \"partner:organizations:read\",\n  \"partner:organizations:write\",\n  \"partner:organizations:access\",\n  \"partner:mailbox_credentials:issue\",\n  \"partner:usage:read\",\n] as const;\n\nexport type ApiKeyScope = (typeof API_KEY_SCOPES)[number];\n\nexport const API_KEY_SCOPE_DESCRIPTIONS: Readonly<Record<ApiKeyScope, string>> = {\n  \"*\": \"All non-partner API endpoints in this organization.\",\n  \"audiences:read\": \"List and retrieve newsletter audiences and their subscribers.\",\n  \"audiences:write\": \"Create audiences and add, update, or remove their subscribers.\",\n  \"booking_pages:read\": \"List and retrieve booking pages.\",\n  \"booking_pages:write\": \"Create, update, and delete booking pages.\",\n  \"calendar:read\": \"List and retrieve calendar events and open availability.\",\n  \"calendar:write\": \"Create, update, and delete calendar events.\",\n  \"domains:read\": \"List, retrieve, and verify domains.\",\n  \"domains:write\": \"Create, update, and delete domains.\",\n  \"mailboxes:read\": \"List and retrieve mailboxes.\",\n  \"mailboxes:export\": \"Create and download mailbox content exports.\",\n  \"mailboxes:write\": \"Create, update, suspend, resume, and delete mailboxes.\",\n  \"mailbox_credentials:read\": \"List revocable app passwords for allowed mailboxes.\",\n  \"mailbox_credentials:write\": \"Create and revoke app passwords for allowed mailboxes.\",\n  \"mailbox_forwarding:read\": \"List forwarding destinations for allowed mailboxes.\",\n  \"mailbox_forwarding:write\": \"Create and remove forwarding destinations for allowed mailboxes.\",\n  \"messages:read\": \"List and retrieve messages.\",\n  \"messages:write\": \"Update, move, delete, and inject sandbox messages.\",\n  \"drafts:write\": \"Create agent-safe reply drafts with server-derived recipients.\",\n  \"messages:send\": \"Send messages, replies, and approved reply drafts.\",\n  \"newsletters:read\": \"List and retrieve newsletter drafts and campaigns.\",\n  \"newsletters:write\": \"Create, update, test, schedule, cancel, and resume newsletters.\",\n  \"threads:read\": \"List threads and retrieve thread messages.\",\n  \"webhooks:read\": \"List webhooks, retrieve webhooks, and list deliveries.\",\n  \"webhooks:write\": \"Create, update, delete, test, and rotate webhooks.\",\n  \"suppressions:read\": \"List suppressed recipient addresses.\",\n  \"suppressions:write\": \"Remove addresses from the suppression list.\",\n  \"partner:organizations:read\": \"List and retrieve this partner's child organizations.\",\n  \"partner:organizations:write\": \"Create and manage this partner's child organizations.\",\n  \"partner:organizations:access\": \"Act on an active child using the delegated organization header.\",\n  \"partner:mailbox_credentials:issue\":\n    \"List and consume operator-approved grants for embedded-webmail credentials.\",\n  \"partner:usage:read\": \"Read consolidated child and mailbox usage for this partner.\",\n};\n\nexport function isApiKeyScope(value: string): value is ApiKeyScope {\n  return API_KEY_SCOPES.some((scope) => scope === value);\n}\n\nexport function apiKeyScopesGrant(\n  grantedScopes: readonly string[],\n  requiredScope: ApiKeyScope | \"public\",\n): boolean {\n  if (requiredScope === \"public\") return true;\n  if (requiredScope.startsWith(\"partner:\")) return grantedScopes.includes(requiredScope);\n  return grantedScopes.includes(\"*\") || grantedScopes.includes(requiredScope);\n}\n"]}
+{"version":3,"sources":["../src/api-key-scopes.ts"],"names":[],"mappings":";;;AAAO,IAAM,cAAA,GAAiB;AAAA,EAC5B,GAAA;AAAA,EACA,gBAAA;AAAA,EACA,iBAAA;AAAA,EACA,oBAAA;AAAA,EACA,qBAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,kBAAA;AAAA,EACA,iBAAA;AAAA,EACA,0BAAA;AAAA,EACA,2BAAA;AAAA,EACA,yBAAA;AAAA,EACA,0BAAA;AAAA,EACA,oBAAA;AAAA,EACA,qBAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,kBAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,mBAAA;AAAA,EACA,oBAAA;AAAA,EACA,4BAAA;AAAA,EACA,6BAAA;AAAA,EACA,8BAAA;AAAA,EACA,mCAAA;AAAA,EACA;AACF;AAIO,IAAM,0BAAA,GAAoE;AAAA,EAC/E,GAAA,EAAK,qDAAA;AAAA,EACL,gBAAA,EAAkB,+DAAA;AAAA,EAClB,iBAAA,EAAmB,gEAAA;AAAA,EACnB,oBAAA,EAAsB,kCAAA;AAAA,EACtB,qBAAA,EAAuB,2CAAA;AAAA,EACvB,eAAA,EAAiB,0DAAA;AAAA,EACjB,gBAAA,EAAkB,6CAAA;AAAA,EAClB,cAAA,EAAgB,qCAAA;AAAA,EAChB,eAAA,EAAiB,qCAAA;AAAA,EACjB,gBAAA,EAAkB,8BAAA;AAAA,EAClB,kBAAA,EAAoB,8CAAA;AAAA,EACpB,iBAAA,EAAmB,wDAAA;AAAA,EACnB,0BAAA,EAA4B,qDAAA;AAAA,EAC5B,2BAAA,EAA6B,wDAAA;AAAA,EAC7B,yBAAA,EAA2B,qDAAA;AAAA,EAC3B,0BAAA,EAA4B,kEAAA;AAAA,EAC5B,oBAAA,EAAsB,6DAAA;AAAA,EACtB,qBAAA,EAAuB,wEAAA;AAAA,EACvB,eAAA,EAAiB,6BAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,cAAA,EAAgB,gEAAA;AAAA,EAChB,eAAA,EAAiB,oDAAA;AAAA,EACjB,kBAAA,EAAoB,oDAAA;AAAA,EACpB,mBAAA,EAAqB,iEAAA;AAAA,EACrB,cAAA,EAAgB,4CAAA;AAAA,EAChB,eAAA,EAAiB,wDAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,mBAAA,EAAqB,sCAAA;AAAA,EACrB,oBAAA,EAAsB,6CAAA;AAAA,EACtB,4BAAA,EAA8B,uDAAA;AAAA,EAC9B,6BAAA,EAA+B,uDAAA;AAAA,EAC/B,8BAAA,EAAgC,iEAAA;AAAA,EAChC,mCAAA,EACE,6EAAA;AAAA,EACF,oBAAA,EAAsB;AACxB;AAEO,SAAS,cAAc,KAAA,EAAqC;AACjE,EAAA,OAAO,cAAA,CAAe,IAAA,CAAK,CAAC,KAAA,KAAU,UAAU,KAAK,CAAA;AACvD;AAEO,SAAS,iBAAA,CACd,eACA,aAAA,EACS;AACT,EAAA,IAAI,aAAA,KAAkB,UAAU,OAAO,IAAA;AACvC,EAAA,IAAI,cAAc,UAAA,CAAW,UAAU,GAAG,OAAO,aAAA,CAAc,SAAS,aAAa,CAAA;AACrF,EAAA,OAAO,cAAc,QAAA,CAAS,GAAG,CAAA,IAAK,aAAA,CAAc,SAAS,aAAa,CAAA;AAC5E","file":"api-key-scopes.cjs","sourcesContent":["export const API_KEY_SCOPES = [\n  \"*\",\n  \"audiences:read\",\n  \"audiences:write\",\n  \"booking_pages:read\",\n  \"booking_pages:write\",\n  \"calendar:read\",\n  \"calendar:write\",\n  \"domains:read\",\n  \"domains:write\",\n  \"mailboxes:read\",\n  \"mailboxes:export\",\n  \"mailboxes:write\",\n  \"mailbox_credentials:read\",\n  \"mailbox_credentials:write\",\n  \"mailbox_forwarding:read\",\n  \"mailbox_forwarding:write\",\n  \"mailbox_rules:read\",\n  \"mailbox_rules:write\",\n  \"messages:read\",\n  \"messages:write\",\n  \"drafts:write\",\n  \"messages:send\",\n  \"newsletters:read\",\n  \"newsletters:write\",\n  \"threads:read\",\n  \"webhooks:read\",\n  \"webhooks:write\",\n  \"suppressions:read\",\n  \"suppressions:write\",\n  \"partner:organizations:read\",\n  \"partner:organizations:write\",\n  \"partner:organizations:access\",\n  \"partner:mailbox_credentials:issue\",\n  \"partner:usage:read\",\n] as const;\n\nexport type ApiKeyScope = (typeof API_KEY_SCOPES)[number];\n\nexport const API_KEY_SCOPE_DESCRIPTIONS: Readonly<Record<ApiKeyScope, string>> = {\n  \"*\": \"All non-partner API endpoints in this organization.\",\n  \"audiences:read\": \"List and retrieve newsletter audiences and their subscribers.\",\n  \"audiences:write\": \"Create audiences and add, update, or remove their subscribers.\",\n  \"booking_pages:read\": \"List and retrieve booking pages.\",\n  \"booking_pages:write\": \"Create, update, and delete booking pages.\",\n  \"calendar:read\": \"List and retrieve calendar events and open availability.\",\n  \"calendar:write\": \"Create, update, and delete calendar events.\",\n  \"domains:read\": \"List, retrieve, and verify domains.\",\n  \"domains:write\": \"Create, update, and delete domains.\",\n  \"mailboxes:read\": \"List and retrieve mailboxes.\",\n  \"mailboxes:export\": \"Create and download mailbox content exports.\",\n  \"mailboxes:write\": \"Create, update, suspend, resume, and delete mailboxes.\",\n  \"mailbox_credentials:read\": \"List revocable app passwords for allowed mailboxes.\",\n  \"mailbox_credentials:write\": \"Create and revoke app passwords for allowed mailboxes.\",\n  \"mailbox_forwarding:read\": \"List forwarding destinations for allowed mailboxes.\",\n  \"mailbox_forwarding:write\": \"Create and remove forwarding destinations for allowed mailboxes.\",\n  \"mailbox_rules:read\": \"List deterministic server-side rules for allowed mailboxes.\",\n  \"mailbox_rules:write\": \"Create, replace, and remove deterministic rules for allowed mailboxes.\",\n  \"messages:read\": \"List and retrieve messages.\",\n  \"messages:write\": \"Update, move, delete, and inject sandbox messages.\",\n  \"drafts:write\": \"Create agent-safe reply drafts with server-derived recipients.\",\n  \"messages:send\": \"Send messages, replies, and approved reply drafts.\",\n  \"newsletters:read\": \"List and retrieve newsletter drafts and campaigns.\",\n  \"newsletters:write\": \"Create, update, test, schedule, cancel, and resume newsletters.\",\n  \"threads:read\": \"List threads and retrieve thread messages.\",\n  \"webhooks:read\": \"List webhooks, retrieve webhooks, and list deliveries.\",\n  \"webhooks:write\": \"Create, update, delete, test, and rotate webhooks.\",\n  \"suppressions:read\": \"List suppressed recipient addresses.\",\n  \"suppressions:write\": \"Remove addresses from the suppression list.\",\n  \"partner:organizations:read\": \"List and retrieve this partner's child organizations.\",\n  \"partner:organizations:write\": \"Create and manage this partner's child organizations.\",\n  \"partner:organizations:access\": \"Act on an active child using the delegated organization header.\",\n  \"partner:mailbox_credentials:issue\":\n    \"List and consume operator-approved grants for embedded-webmail credentials.\",\n  \"partner:usage:read\": \"Read consolidated child and mailbox usage for this partner.\",\n};\n\nexport function isApiKeyScope(value: string): value is ApiKeyScope {\n  return API_KEY_SCOPES.some((scope) => scope === value);\n}\n\nexport function apiKeyScopesGrant(\n  grantedScopes: readonly string[],\n  requiredScope: ApiKeyScope | \"public\",\n): boolean {\n  if (requiredScope === \"public\") return true;\n  if (requiredScope.startsWith(\"partner:\")) return grantedScopes.includes(requiredScope);\n  return grantedScopes.includes(\"*\") || grantedScopes.includes(requiredScope);\n}\n"]}

package/dist/api-key-scopes.d.cts

@@ -1,4 +1,4 @@
-declare const API_KEY_SCOPES: readonly ["*", "audiences:read", "audiences:write", "booking_pages:read", "booking_pages:write", "calendar:read", "calendar:write", "domains:read", "domains:write", "mailboxes:read", "mailboxes:export", "mailboxes:write", "mailbox_credentials:read", "mailbox_credentials:write", "mailbox_forwarding:read", "mailbox_forwarding:write", "messages:read", "messages:write", "drafts:write", "messages:send", "newsletters:read", "newsletters:write", "threads:read", "webhooks:read", "webhooks:write", "suppressions:read", "suppressions:write", "partner:organizations:read", "partner:organizations:write", "partner:organizations:access", "partner:mailbox_credentials:issue", "partner:usage:read"];
+declare const API_KEY_SCOPES: readonly ["*", "audiences:read", "audiences:write", "booking_pages:read", "booking_pages:write", "calendar:read", "calendar:write", "domains:read", "domains:write", "mailboxes:read", "mailboxes:export", "mailboxes:write", "mailbox_credentials:read", "mailbox_credentials:write", "mailbox_forwarding:read", "mailbox_forwarding:write", "mailbox_rules:read", "mailbox_rules:write", "messages:read", "messages:write", "drafts:write", "messages:send", "newsletters:read", "newsletters:write", "threads:read", "webhooks:read", "webhooks:write", "suppressions:read", "suppressions:write", "partner:organizations:read", "partner:organizations:write", "partner:organizations:access", "partner:mailbox_credentials:issue", "partner:usage:read"];
 type ApiKeyScope = (typeof API_KEY_SCOPES)[number];
 declare const API_KEY_SCOPE_DESCRIPTIONS: Readonly<Record<ApiKeyScope, string>>;
 declare function isApiKeyScope(value: string): value is ApiKeyScope;

package/dist/api-key-scopes.d.ts

@@ -1,4 +1,4 @@
-declare const API_KEY_SCOPES: readonly ["*", "audiences:read", "audiences:write", "booking_pages:read", "booking_pages:write", "calendar:read", "calendar:write", "domains:read", "domains:write", "mailboxes:read", "mailboxes:export", "mailboxes:write", "mailbox_credentials:read", "mailbox_credentials:write", "mailbox_forwarding:read", "mailbox_forwarding:write", "messages:read", "messages:write", "drafts:write", "messages:send", "newsletters:read", "newsletters:write", "threads:read", "webhooks:read", "webhooks:write", "suppressions:read", "suppressions:write", "partner:organizations:read", "partner:organizations:write", "partner:organizations:access", "partner:mailbox_credentials:issue", "partner:usage:read"];
+declare const API_KEY_SCOPES: readonly ["*", "audiences:read", "audiences:write", "booking_pages:read", "booking_pages:write", "calendar:read", "calendar:write", "domains:read", "domains:write", "mailboxes:read", "mailboxes:export", "mailboxes:write", "mailbox_credentials:read", "mailbox_credentials:write", "mailbox_forwarding:read", "mailbox_forwarding:write", "mailbox_rules:read", "mailbox_rules:write", "messages:read", "messages:write", "drafts:write", "messages:send", "newsletters:read", "newsletters:write", "threads:read", "webhooks:read", "webhooks:write", "suppressions:read", "suppressions:write", "partner:organizations:read", "partner:organizations:write", "partner:organizations:access", "partner:mailbox_credentials:issue", "partner:usage:read"];
 type ApiKeyScope = (typeof API_KEY_SCOPES)[number];
 declare const API_KEY_SCOPE_DESCRIPTIONS: Readonly<Record<ApiKeyScope, string>>;
 declare function isApiKeyScope(value: string): value is ApiKeyScope;

package/dist/api-key-scopes.js

@@ -16,6 +16,8 @@ var API_KEY_SCOPES = [
   "mailbox_credentials:write",
   "mailbox_forwarding:read",
   "mailbox_forwarding:write",
+  "mailbox_rules:read",
+  "mailbox_rules:write",
   "messages:read",
   "messages:write",
   "drafts:write",
@@ -50,6 +52,8 @@ var API_KEY_SCOPE_DESCRIPTIONS = {
   "mailbox_credentials:write": "Create and revoke app passwords for allowed mailboxes.",
   "mailbox_forwarding:read": "List forwarding destinations for allowed mailboxes.",
   "mailbox_forwarding:write": "Create and remove forwarding destinations for allowed mailboxes.",
+  "mailbox_rules:read": "List deterministic server-side rules for allowed mailboxes.",
+  "mailbox_rules:write": "Create, replace, and remove deterministic rules for allowed mailboxes.",
   "messages:read": "List and retrieve messages.",
   "messages:write": "Update, move, delete, and inject sandbox messages.",
   "drafts:write": "Create agent-safe reply drafts with server-derived recipients.",

package/dist/api-key-scopes.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/api-key-scopes.ts"],"names":[],"mappings":";AAAO,IAAM,cAAA,GAAiB;AAAA,EAC5B,GAAA;AAAA,EACA,gBAAA;AAAA,EACA,iBAAA;AAAA,EACA,oBAAA;AAAA,EACA,qBAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,kBAAA;AAAA,EACA,iBAAA;AAAA,EACA,0BAAA;AAAA,EACA,2BAAA;AAAA,EACA,yBAAA;AAAA,EACA,0BAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,kBAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,mBAAA;AAAA,EACA,oBAAA;AAAA,EACA,4BAAA;AAAA,EACA,6BAAA;AAAA,EACA,8BAAA;AAAA,EACA,mCAAA;AAAA,EACA;AACF;AAIO,IAAM,0BAAA,GAAoE;AAAA,EAC/E,GAAA,EAAK,qDAAA;AAAA,EACL,gBAAA,EAAkB,+DAAA;AAAA,EAClB,iBAAA,EAAmB,gEAAA;AAAA,EACnB,oBAAA,EAAsB,kCAAA;AAAA,EACtB,qBAAA,EAAuB,2CAAA;AAAA,EACvB,eAAA,EAAiB,0DAAA;AAAA,EACjB,gBAAA,EAAkB,6CAAA;AAAA,EAClB,cAAA,EAAgB,qCAAA;AAAA,EAChB,eAAA,EAAiB,qCAAA;AAAA,EACjB,gBAAA,EAAkB,8BAAA;AAAA,EAClB,kBAAA,EAAoB,8CAAA;AAAA,EACpB,iBAAA,EAAmB,wDAAA;AAAA,EACnB,0BAAA,EAA4B,qDAAA;AAAA,EAC5B,2BAAA,EAA6B,wDAAA;AAAA,EAC7B,yBAAA,EAA2B,qDAAA;AAAA,EAC3B,0BAAA,EAA4B,kEAAA;AAAA,EAC5B,eAAA,EAAiB,6BAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,cAAA,EAAgB,gEAAA;AAAA,EAChB,eAAA,EAAiB,oDAAA;AAAA,EACjB,kBAAA,EAAoB,oDAAA;AAAA,EACpB,mBAAA,EAAqB,iEAAA;AAAA,EACrB,cAAA,EAAgB,4CAAA;AAAA,EAChB,eAAA,EAAiB,wDAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,mBAAA,EAAqB,sCAAA;AAAA,EACrB,oBAAA,EAAsB,6CAAA;AAAA,EACtB,4BAAA,EAA8B,uDAAA;AAAA,EAC9B,6BAAA,EAA+B,uDAAA;AAAA,EAC/B,8BAAA,EAAgC,iEAAA;AAAA,EAChC,mCAAA,EACE,6EAAA;AAAA,EACF,oBAAA,EAAsB;AACxB;AAEO,SAAS,cAAc,KAAA,EAAqC;AACjE,EAAA,OAAO,cAAA,CAAe,IAAA,CAAK,CAAC,KAAA,KAAU,UAAU,KAAK,CAAA;AACvD;AAEO,SAAS,iBAAA,CACd,eACA,aAAA,EACS;AACT,EAAA,IAAI,aAAA,KAAkB,UAAU,OAAO,IAAA;AACvC,EAAA,IAAI,cAAc,UAAA,CAAW,UAAU,GAAG,OAAO,aAAA,CAAc,SAAS,aAAa,CAAA;AACrF,EAAA,OAAO,cAAc,QAAA,CAAS,GAAG,CAAA,IAAK,aAAA,CAAc,SAAS,aAAa,CAAA;AAC5E","file":"api-key-scopes.js","sourcesContent":["export const API_KEY_SCOPES = [\n  \"*\",\n  \"audiences:read\",\n  \"audiences:write\",\n  \"booking_pages:read\",\n  \"booking_pages:write\",\n  \"calendar:read\",\n  \"calendar:write\",\n  \"domains:read\",\n  \"domains:write\",\n  \"mailboxes:read\",\n  \"mailboxes:export\",\n  \"mailboxes:write\",\n  \"mailbox_credentials:read\",\n  \"mailbox_credentials:write\",\n  \"mailbox_forwarding:read\",\n  \"mailbox_forwarding:write\",\n  \"messages:read\",\n  \"messages:write\",\n  \"drafts:write\",\n  \"messages:send\",\n  \"newsletters:read\",\n  \"newsletters:write\",\n  \"threads:read\",\n  \"webhooks:read\",\n  \"webhooks:write\",\n  \"suppressions:read\",\n  \"suppressions:write\",\n  \"partner:organizations:read\",\n  \"partner:organizations:write\",\n  \"partner:organizations:access\",\n  \"partner:mailbox_credentials:issue\",\n  \"partner:usage:read\",\n] as const;\n\nexport type ApiKeyScope = (typeof API_KEY_SCOPES)[number];\n\nexport const API_KEY_SCOPE_DESCRIPTIONS: Readonly<Record<ApiKeyScope, string>> = {\n  \"*\": \"All non-partner API endpoints in this organization.\",\n  \"audiences:read\": \"List and retrieve newsletter audiences and their subscribers.\",\n  \"audiences:write\": \"Create audiences and add, update, or remove their subscribers.\",\n  \"booking_pages:read\": \"List and retrieve booking pages.\",\n  \"booking_pages:write\": \"Create, update, and delete booking pages.\",\n  \"calendar:read\": \"List and retrieve calendar events and open availability.\",\n  \"calendar:write\": \"Create, update, and delete calendar events.\",\n  \"domains:read\": \"List, retrieve, and verify domains.\",\n  \"domains:write\": \"Create, update, and delete domains.\",\n  \"mailboxes:read\": \"List and retrieve mailboxes.\",\n  \"mailboxes:export\": \"Create and download mailbox content exports.\",\n  \"mailboxes:write\": \"Create, update, suspend, resume, and delete mailboxes.\",\n  \"mailbox_credentials:read\": \"List revocable app passwords for allowed mailboxes.\",\n  \"mailbox_credentials:write\": \"Create and revoke app passwords for allowed mailboxes.\",\n  \"mailbox_forwarding:read\": \"List forwarding destinations for allowed mailboxes.\",\n  \"mailbox_forwarding:write\": \"Create and remove forwarding destinations for allowed mailboxes.\",\n  \"messages:read\": \"List and retrieve messages.\",\n  \"messages:write\": \"Update, move, delete, and inject sandbox messages.\",\n  \"drafts:write\": \"Create agent-safe reply drafts with server-derived recipients.\",\n  \"messages:send\": \"Send messages, replies, and approved reply drafts.\",\n  \"newsletters:read\": \"List and retrieve newsletter drafts and campaigns.\",\n  \"newsletters:write\": \"Create, update, test, schedule, cancel, and resume newsletters.\",\n  \"threads:read\": \"List threads and retrieve thread messages.\",\n  \"webhooks:read\": \"List webhooks, retrieve webhooks, and list deliveries.\",\n  \"webhooks:write\": \"Create, update, delete, test, and rotate webhooks.\",\n  \"suppressions:read\": \"List suppressed recipient addresses.\",\n  \"suppressions:write\": \"Remove addresses from the suppression list.\",\n  \"partner:organizations:read\": \"List and retrieve this partner's child organizations.\",\n  \"partner:organizations:write\": \"Create and manage this partner's child organizations.\",\n  \"partner:organizations:access\": \"Act on an active child using the delegated organization header.\",\n  \"partner:mailbox_credentials:issue\":\n    \"List and consume operator-approved grants for embedded-webmail credentials.\",\n  \"partner:usage:read\": \"Read consolidated child and mailbox usage for this partner.\",\n};\n\nexport function isApiKeyScope(value: string): value is ApiKeyScope {\n  return API_KEY_SCOPES.some((scope) => scope === value);\n}\n\nexport function apiKeyScopesGrant(\n  grantedScopes: readonly string[],\n  requiredScope: ApiKeyScope | \"public\",\n): boolean {\n  if (requiredScope === \"public\") return true;\n  if (requiredScope.startsWith(\"partner:\")) return grantedScopes.includes(requiredScope);\n  return grantedScopes.includes(\"*\") || grantedScopes.includes(requiredScope);\n}\n"]}
+{"version":3,"sources":["../src/api-key-scopes.ts"],"names":[],"mappings":";AAAO,IAAM,cAAA,GAAiB;AAAA,EAC5B,GAAA;AAAA,EACA,gBAAA;AAAA,EACA,iBAAA;AAAA,EACA,oBAAA;AAAA,EACA,qBAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,kBAAA;AAAA,EACA,iBAAA;AAAA,EACA,0BAAA;AAAA,EACA,2BAAA;AAAA,EACA,yBAAA;AAAA,EACA,0BAAA;AAAA,EACA,oBAAA;AAAA,EACA,qBAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,kBAAA;AAAA,EACA,mBAAA;AAAA,EACA,cAAA;AAAA,EACA,eAAA;AAAA,EACA,gBAAA;AAAA,EACA,mBAAA;AAAA,EACA,oBAAA;AAAA,EACA,4BAAA;AAAA,EACA,6BAAA;AAAA,EACA,8BAAA;AAAA,EACA,mCAAA;AAAA,EACA;AACF;AAIO,IAAM,0BAAA,GAAoE;AAAA,EAC/E,GAAA,EAAK,qDAAA;AAAA,EACL,gBAAA,EAAkB,+DAAA;AAAA,EAClB,iBAAA,EAAmB,gEAAA;AAAA,EACnB,oBAAA,EAAsB,kCAAA;AAAA,EACtB,qBAAA,EAAuB,2CAAA;AAAA,EACvB,eAAA,EAAiB,0DAAA;AAAA,EACjB,gBAAA,EAAkB,6CAAA;AAAA,EAClB,cAAA,EAAgB,qCAAA;AAAA,EAChB,eAAA,EAAiB,qCAAA;AAAA,EACjB,gBAAA,EAAkB,8BAAA;AAAA,EAClB,kBAAA,EAAoB,8CAAA;AAAA,EACpB,iBAAA,EAAmB,wDAAA;AAAA,EACnB,0BAAA,EAA4B,qDAAA;AAAA,EAC5B,2BAAA,EAA6B,wDAAA;AAAA,EAC7B,yBAAA,EAA2B,qDAAA;AAAA,EAC3B,0BAAA,EAA4B,kEAAA;AAAA,EAC5B,oBAAA,EAAsB,6DAAA;AAAA,EACtB,qBAAA,EAAuB,wEAAA;AAAA,EACvB,eAAA,EAAiB,6BAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,cAAA,EAAgB,gEAAA;AAAA,EAChB,eAAA,EAAiB,oDAAA;AAAA,EACjB,kBAAA,EAAoB,oDAAA;AAAA,EACpB,mBAAA,EAAqB,iEAAA;AAAA,EACrB,cAAA,EAAgB,4CAAA;AAAA,EAChB,eAAA,EAAiB,wDAAA;AAAA,EACjB,gBAAA,EAAkB,oDAAA;AAAA,EAClB,mBAAA,EAAqB,sCAAA;AAAA,EACrB,oBAAA,EAAsB,6CAAA;AAAA,EACtB,4BAAA,EAA8B,uDAAA;AAAA,EAC9B,6BAAA,EAA+B,uDAAA;AAAA,EAC/B,8BAAA,EAAgC,iEAAA;AAAA,EAChC,mCAAA,EACE,6EAAA;AAAA,EACF,oBAAA,EAAsB;AACxB;AAEO,SAAS,cAAc,KAAA,EAAqC;AACjE,EAAA,OAAO,cAAA,CAAe,IAAA,CAAK,CAAC,KAAA,KAAU,UAAU,KAAK,CAAA;AACvD;AAEO,SAAS,iBAAA,CACd,eACA,aAAA,EACS;AACT,EAAA,IAAI,aAAA,KAAkB,UAAU,OAAO,IAAA;AACvC,EAAA,IAAI,cAAc,UAAA,CAAW,UAAU,GAAG,OAAO,aAAA,CAAc,SAAS,aAAa,CAAA;AACrF,EAAA,OAAO,cAAc,QAAA,CAAS,GAAG,CAAA,IAAK,aAAA,CAAc,SAAS,aAAa,CAAA;AAC5E","file":"api-key-scopes.js","sourcesContent":["export const API_KEY_SCOPES = [\n  \"*\",\n  \"audiences:read\",\n  \"audiences:write\",\n  \"booking_pages:read\",\n  \"booking_pages:write\",\n  \"calendar:read\",\n  \"calendar:write\",\n  \"domains:read\",\n  \"domains:write\",\n  \"mailboxes:read\",\n  \"mailboxes:export\",\n  \"mailboxes:write\",\n  \"mailbox_credentials:read\",\n  \"mailbox_credentials:write\",\n  \"mailbox_forwarding:read\",\n  \"mailbox_forwarding:write\",\n  \"mailbox_rules:read\",\n  \"mailbox_rules:write\",\n  \"messages:read\",\n  \"messages:write\",\n  \"drafts:write\",\n  \"messages:send\",\n  \"newsletters:read\",\n  \"newsletters:write\",\n  \"threads:read\",\n  \"webhooks:read\",\n  \"webhooks:write\",\n  \"suppressions:read\",\n  \"suppressions:write\",\n  \"partner:organizations:read\",\n  \"partner:organizations:write\",\n  \"partner:organizations:access\",\n  \"partner:mailbox_credentials:issue\",\n  \"partner:usage:read\",\n] as const;\n\nexport type ApiKeyScope = (typeof API_KEY_SCOPES)[number];\n\nexport const API_KEY_SCOPE_DESCRIPTIONS: Readonly<Record<ApiKeyScope, string>> = {\n  \"*\": \"All non-partner API endpoints in this organization.\",\n  \"audiences:read\": \"List and retrieve newsletter audiences and their subscribers.\",\n  \"audiences:write\": \"Create audiences and add, update, or remove their subscribers.\",\n  \"booking_pages:read\": \"List and retrieve booking pages.\",\n  \"booking_pages:write\": \"Create, update, and delete booking pages.\",\n  \"calendar:read\": \"List and retrieve calendar events and open availability.\",\n  \"calendar:write\": \"Create, update, and delete calendar events.\",\n  \"domains:read\": \"List, retrieve, and verify domains.\",\n  \"domains:write\": \"Create, update, and delete domains.\",\n  \"mailboxes:read\": \"List and retrieve mailboxes.\",\n  \"mailboxes:export\": \"Create and download mailbox content exports.\",\n  \"mailboxes:write\": \"Create, update, suspend, resume, and delete mailboxes.\",\n  \"mailbox_credentials:read\": \"List revocable app passwords for allowed mailboxes.\",\n  \"mailbox_credentials:write\": \"Create and revoke app passwords for allowed mailboxes.\",\n  \"mailbox_forwarding:read\": \"List forwarding destinations for allowed mailboxes.\",\n  \"mailbox_forwarding:write\": \"Create and remove forwarding destinations for allowed mailboxes.\",\n  \"mailbox_rules:read\": \"List deterministic server-side rules for allowed mailboxes.\",\n  \"mailbox_rules:write\": \"Create, replace, and remove deterministic rules for allowed mailboxes.\",\n  \"messages:read\": \"List and retrieve messages.\",\n  \"messages:write\": \"Update, move, delete, and inject sandbox messages.\",\n  \"drafts:write\": \"Create agent-safe reply drafts with server-derived recipients.\",\n  \"messages:send\": \"Send messages, replies, and approved reply drafts.\",\n  \"newsletters:read\": \"List and retrieve newsletter drafts and campaigns.\",\n  \"newsletters:write\": \"Create, update, test, schedule, cancel, and resume newsletters.\",\n  \"threads:read\": \"List threads and retrieve thread messages.\",\n  \"webhooks:read\": \"List webhooks, retrieve webhooks, and list deliveries.\",\n  \"webhooks:write\": \"Create, update, delete, test, and rotate webhooks.\",\n  \"suppressions:read\": \"List suppressed recipient addresses.\",\n  \"suppressions:write\": \"Remove addresses from the suppression list.\",\n  \"partner:organizations:read\": \"List and retrieve this partner's child organizations.\",\n  \"partner:organizations:write\": \"Create and manage this partner's child organizations.\",\n  \"partner:organizations:access\": \"Act on an active child using the delegated organization header.\",\n  \"partner:mailbox_credentials:issue\":\n    \"List and consume operator-approved grants for embedded-webmail credentials.\",\n  \"partner:usage:read\": \"Read consolidated child and mailbox usage for this partner.\",\n};\n\nexport function isApiKeyScope(value: string): value is ApiKeyScope {\n  return API_KEY_SCOPES.some((scope) => scope === value);\n}\n\nexport function apiKeyScopesGrant(\n  grantedScopes: readonly string[],\n  requiredScope: ApiKeyScope | \"public\",\n): boolean {\n  if (requiredScope === \"public\") return true;\n  if (requiredScope.startsWith(\"partner:\")) return grantedScopes.includes(requiredScope);\n  return grantedScopes.includes(\"*\") || grantedScopes.includes(requiredScope);\n}\n"]}

package/dist/index.cjs

@@ -20,6 +20,8 @@ var API_KEY_SCOPES = [
   "mailbox_credentials:write",
   "mailbox_forwarding:read",
   "mailbox_forwarding:write",
+  "mailbox_rules:read",
+  "mailbox_rules:write",
   "messages:read",
   "messages:write",
   "drafts:write",
@@ -54,6 +56,8 @@ var API_KEY_SCOPE_DESCRIPTIONS = {
   "mailbox_credentials:write": "Create and revoke app passwords for allowed mailboxes.",
   "mailbox_forwarding:read": "List forwarding destinations for allowed mailboxes.",
   "mailbox_forwarding:write": "Create and remove forwarding destinations for allowed mailboxes.",
+  "mailbox_rules:read": "List deterministic server-side rules for allowed mailboxes.",
+  "mailbox_rules:write": "Create, replace, and remove deterministic rules for allowed mailboxes.",
   "messages:read": "List and retrieve messages.",
   "messages:write": "Update, move, delete, and inject sandbox messages.",
   "drafts:write": "Create agent-safe reply drafts with server-derived recipients.",
@@ -874,6 +878,21 @@ var Mailboxes = class extends ApiResource {
       methodOptions: options
     });
   }
+  getRules(id, options) {
+    return this.client.request({
+      method: "GET",
+      path: `/mailboxes/${encodeURIComponent(id)}/rules`,
+      methodOptions: options
+    });
+  }
+  updateRules(id, params, options) {
+    return this.client.request({
+      method: "PUT",
+      path: `/mailboxes/${encodeURIComponent(id)}/rules`,
+      body: params,
+      methodOptions: options
+    });
+  }
   listForwarding(id, options) {
     return this.client.request({
       method: "GET",
@@ -1485,7 +1504,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.4.1";
+var VERSION = "0.4.3";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1660,6 +1679,7 @@ var WEBHOOK_EVENT_TYPES = [
   "message.bounced",
   "message.complained",
   "thread.needs_reply",
+  "mailbox.rule_matched",
   "domain.verified",
   "domain.verification_failed",
   "domain.degraded",