@pidgeon-ai/sdk 1.30.0 → 1.31.1

package/CHANGELOG.md

@@ -7,6 +7,21 @@ the two would publish a release for every unrelated product deploy.
 Semver applies to **this package's own surface** — the exported names, the
 call shapes, the result shape — not to the API behind it.
 
+## 1.31.1 — inbox, address, folder
+
+Descriptions only. Where the docs said "mailbox" they now say inbox (what an
+agent or a person has), address (`name@domain`, which the API calls an
+identity) or folder. Every name stays: `mailboxes.list`, `/v1/mailboxes`,
+`identity_id`. No shape moves.
+
+## 1.31.0 — `receive_policy`
+
+Every address carries `receive_policy`: `open` (anyone, the default) or
+`list`, which accepts only senders with an `inbox` receive rule on mail that
+passes DMARC and refuses everybody else before anything is stored.
+`identitiesUpdate` sets it; `identitiesReceiveRulesList` and
+`identitiesReceiveRulesCreate` return it beside the rules. Additive.
+
 ## 1.30.0 — `authentication.signature`
 
 A message carries `authentication.signature`: `pass` when it came from

package/dist/index.d.cts

@@ -331,7 +331,7 @@ type ClientOptions = {
     baseUrl: 'https://pidgeon.ai/api/v1' | (string & {});
 };
 /**
- * A mailbox, with the display name when one was given.
+ * An address, with the display name when one was given.
  */
 type Address = {
     email: string;
@@ -425,6 +425,10 @@ type Identity = {
      * Who it may write to: open, reply_only (somebody who wrote to it first), or list.
      */
     send_policy: string;
+    /**
+     * Who may write to it: open, or list (only senders with an inbox rule, on mail that passes DMARC).
+     */
+    receive_policy: string;
     /**
      * Your own opaque grouping for this address. Never parsed here.
      */
@@ -438,13 +442,13 @@ type Message = {
     id: string;
     thread_id: string;
     /**
-     * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
+     * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
      */
     identity_id: string | null;
     identity: string | null;
     direction: string;
     /**
-     * A mailbox, with the display name when one was given.
+     * An address, with the display name when one was given.
      */
     from: {
         email: string;
@@ -658,13 +662,13 @@ type AwaitedMessage = {
         id: string;
         thread_id: string;
         /**
-         * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
+         * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
          */
         identity_id: string | null;
         identity: string | null;
         direction: string;
         /**
-         * A mailbox, with the display name when one was given.
+         * An address, with the display name when one was given.
          */
         from: {
             email: string;
@@ -1176,7 +1180,7 @@ type EventResponse = {
         updated_at: string;
     };
     /**
-     * Which of the mailbox’s addresses answered.
+     * Which of the inbox’s addresses answered.
      */
     attendee: string;
     status: string;
@@ -1188,7 +1192,7 @@ type EventResponse = {
 type InvitationResponse = {
     status: string;
     /**
-     * Which of the mailbox’s addresses answered.
+     * Which of the inbox’s addresses answered.
      */
     attendee: string;
     /**
@@ -1718,6 +1722,10 @@ type TenantSuspended = {
 };
 type ReceiveRules = {
     identity_id: string;
+    /**
+     * open, or list: only senders with an inbox rule, on mail that passes DMARC.
+     */
+    receive_policy: string;
     rules: Array<{
         id: string;
         /**
@@ -1808,7 +1816,7 @@ type SearchHit = {
      */
     folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
     /**
-     * The mailbox it was found in, as the address. `identity_id` is the same row.
+     * The inbox it was found in, as the address. `identity_id` is the same row.
      */
     identity: string | null;
 };
@@ -1893,6 +1901,10 @@ type PodCreated = {
          * Who it may write to: open, reply_only (somebody who wrote to it first), or list.
          */
         send_policy: string;
+        /**
+         * Who may write to it: open, or list (only senders with an inbox rule, on mail that passes DMARC).
+         */
+        receive_policy: string;
         /**
          * Your own opaque grouping for this address. Never parsed here.
          */
@@ -2512,6 +2524,10 @@ type IdentitiesUpdateData = {
          * Who it may write to. `reply_only` makes an address structurally unable to start a conversation with a stranger.
          */
         send_policy?: 'open' | 'reply_only' | 'list';
+        /**
+         * Who may write to it. `list` accepts only senders with an `inbox` receive rule whose mail passes DMARC, and refuses everybody else before anything is stored. A key with admin on the address may tighten it; loosening needs its owner.
+         */
+        receive_policy?: 'open' | 'list';
         /**
          * Your own opaque grouping — a customer id, whatever your side calls it. Never parsed here.
          */

package/dist/index.d.ts

@@ -331,7 +331,7 @@ type ClientOptions = {
     baseUrl: 'https://pidgeon.ai/api/v1' | (string & {});
 };
 /**
- * A mailbox, with the display name when one was given.
+ * An address, with the display name when one was given.
  */
 type Address = {
     email: string;
@@ -425,6 +425,10 @@ type Identity = {
      * Who it may write to: open, reply_only (somebody who wrote to it first), or list.
      */
     send_policy: string;
+    /**
+     * Who may write to it: open, or list (only senders with an inbox rule, on mail that passes DMARC).
+     */
+    receive_policy: string;
     /**
      * Your own opaque grouping for this address. Never parsed here.
      */
@@ -438,13 +442,13 @@ type Message = {
     id: string;
     thread_id: string;
     /**
-     * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
+     * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
      */
     identity_id: string | null;
     identity: string | null;
     direction: string;
     /**
-     * A mailbox, with the display name when one was given.
+     * An address, with the display name when one was given.
      */
     from: {
         email: string;
@@ -658,13 +662,13 @@ type AwaitedMessage = {
         id: string;
         thread_id: string;
         /**
-         * The mailbox this message is in, as an id. What `POST /attachments` and the other endpoints that take a mailbox expect — `identity` below is the same address as text.
+         * The address this message is in, as an id. What `POST /attachments` and the other endpoints that take an `identity_id` expect — `identity` below is the same address as text.
          */
         identity_id: string | null;
         identity: string | null;
         direction: string;
         /**
-         * A mailbox, with the display name when one was given.
+         * An address, with the display name when one was given.
          */
         from: {
             email: string;
@@ -1176,7 +1180,7 @@ type EventResponse = {
         updated_at: string;
     };
     /**
-     * Which of the mailbox’s addresses answered.
+     * Which of the inbox’s addresses answered.
      */
     attendee: string;
     status: string;
@@ -1188,7 +1192,7 @@ type EventResponse = {
 type InvitationResponse = {
     status: string;
     /**
-     * Which of the mailbox’s addresses answered.
+     * Which of the inbox’s addresses answered.
      */
     attendee: string;
     /**
@@ -1718,6 +1722,10 @@ type TenantSuspended = {
 };
 type ReceiveRules = {
     identity_id: string;
+    /**
+     * open, or list: only senders with an inbox rule, on mail that passes DMARC.
+     */
+    receive_policy: string;
     rules: Array<{
         id: string;
         /**
@@ -1808,7 +1816,7 @@ type SearchHit = {
      */
     folder: 'inbox' | 'starred' | 'sent' | 'drafts' | 'scheduled' | 'snoozed' | 'archive' | 'spam' | 'trash' | 'unauthenticated';
     /**
-     * The mailbox it was found in, as the address. `identity_id` is the same row.
+     * The inbox it was found in, as the address. `identity_id` is the same row.
      */
     identity: string | null;
 };
@@ -1893,6 +1901,10 @@ type PodCreated = {
          * Who it may write to: open, reply_only (somebody who wrote to it first), or list.
          */
         send_policy: string;
+        /**
+         * Who may write to it: open, or list (only senders with an inbox rule, on mail that passes DMARC).
+         */
+        receive_policy: string;
         /**
          * Your own opaque grouping for this address. Never parsed here.
          */
@@ -2512,6 +2524,10 @@ type IdentitiesUpdateData = {
          * Who it may write to. `reply_only` makes an address structurally unable to start a conversation with a stranger.
          */
         send_policy?: 'open' | 'reply_only' | 'list';
+        /**
+         * Who may write to it. `list` accepts only senders with an `inbox` receive rule whose mail passes DMARC, and refuses everybody else before anything is stored. A key with admin on the address may tighten it; loosening needs its owner.
+         */
+        receive_policy?: 'open' | 'list';
         /**
          * Your own opaque grouping — a customer id, whatever your side calls it. Never parsed here.
          */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pidgeon-ai/sdk",
-  "version": "1.30.0",
+  "version": "1.31.1",
   "description": "Email inboxes for AI agents — TypeScript SDK for Pidgeon: create addresses, send, receive and reply.",
   "keywords": [
     "email",