commune-ai 0.1.4 → 0.1.6

package/README.md

@@ -16,6 +16,25 @@ Build agents that receive emails, reply in threads, access conversation history,
 
 ---
 
+## Table of Contents
+
+- [Install](#install)
+- [How to Setup (Dashboard Steps)](#how-to-setup-dashboard-steps)
+  - [1. Create and Verify Domain](#1-create-and-verify-domain)
+  - [2. Create Inbox](#2-create-inbox)
+  - [3. Create API Key](#3-create-api-key)
+  - [4. Configure Webhook](#4-configure-webhook)
+  - [5. Environment Variables](#5-environment-variables)
+- [Receive emails instantly](#receive-emails-instantly)
+- [Reply in email threads](#reply-in-email-threads)
+- [Access conversation history](#access-conversation-history)
+- [Manage Inboxes Programmatically](#manage-inboxes-programmatically)
+- [Listen for Specific Inbox Events](#listen-for-specific-inbox-events)
+- [Semantic Search (Coming Soon)](#semantic-search-coming-soon)
+- [Complete agent example](#complete-agent-example)
+
+---
+
 ## Install
 ```bash
 npm install commune-ai
@@ -224,6 +243,141 @@ console.log(`Found ${searchResults.length} relevant emails`);
 
 ---
 
+## Manage Inboxes Programmatically
+
+Create and manage email inboxes for your agents programmatically.
+
+### Create Multiple Inboxes
+
+Set up different inboxes for different purposes:
+
+```ts
+import { CommuneClient } from "commune-ai";
+
+const client = new CommuneClient({
+  apiKey: process.env.COMMUNE_API_KEY,
+});
+
+// Create inboxes for different departments
+async function setupInboxes(domainId: string) {
+  const supportInbox = await client.inboxes.create(domainId, {
+    localPart: "support",  // Creates support@yourdomain.com
+    agent: {
+      id: "support-agent",
+      name: "Support Bot",
+      metadata: { department: "customer-success" }
+    },
+    status: "active",
+  });
+
+  const salesInbox = await client.inboxes.create(domainId, {
+    localPart: "sales",  // Creates sales@yourdomain.com
+    agent: {
+      id: "sales-agent",
+      name: "Sales Bot",
+      metadata: { department: "sales" }
+    },
+    status: "active",
+  });
+
+  return { supportInbox, salesInbox };
+}
+```
+
+### Set Webhooks for Specific Inboxes
+
+Configure webhooks per inbox to route emails to different handlers:
+
+```ts
+async function configureWebhooks(domainId: string, inboxes: any) {
+  // Support inbox webhook
+  await client.inboxes.setWebhook(domainId, inboxes.supportInbox.id, {
+    endpoint: "https://your-api.com/webhooks/support",
+    events: ["email.received"],
+  });
+
+  // Sales inbox webhook
+  await client.inboxes.setWebhook(domainId, inboxes.salesInbox.id, {
+    endpoint: "https://your-api.com/webhooks/sales",
+    events: ["email.received"],
+  });
+}
+```
+
+### List and Manage Inboxes
+
+```ts
+// List all inboxes for a domain
+const inboxes = await client.inboxes.list(domainId);
+console.log(`Found ${inboxes.length} inboxes`);
+
+// Update an inbox
+await client.inboxes.update(domainId, inboxId, {
+  localPart: "help",  // Change from "support" to "help"
+  status: "active",
+});
+
+// Delete an inbox
+await client.inboxes.remove(domainId, inboxId);
+```
+
+---
+
+## Listen for Specific Inbox Events
+
+Route incoming emails based on which inbox received them:
+
+```ts
+import { createWebhookHandler } from "commune-ai";
+
+const handler = createWebhookHandler({
+  onEvent: async (message, context) => {
+    const { inboxId, inboxAddress } = context.payload;
+
+    console.log(`📧 Email received at: ${inboxAddress}`);
+
+    // Route to different handlers based on inbox
+    if (inboxAddress?.includes("support")) {
+      await handleSupportEmail(message, context);
+    } else if (inboxAddress?.includes("sales")) {
+      await handleSalesEmail(message, context);
+    } else {
+      // Default handler for other inboxes
+      await handleGeneralEmail(message, context);
+    }
+  },
+});
+
+// Example handlers
+async function handleSupportEmail(message: any, context: any) {
+  const sender = message.participants.find(p => p.role === "sender")?.identity;
+  if (sender) {
+    await client.messages.send({
+      to: sender,
+      text: "Thanks for contacting support! We'll get back to you soon.",
+      conversation_id: message.conversation_id,
+      domainId: context.payload.domainId,
+      inboxId: context.payload.inboxId,
+    });
+  }
+}
+
+async function handleSalesEmail(message: any, context: any) {
+  const sender = message.participants.find(p => p.role === "sender")?.identity;
+  if (sender) {
+    await client.messages.send({
+      to: sender,
+      text: "Thanks for your interest! A sales representative will contact you.",
+      conversation_id: message.conversation_id,
+      domainId: context.payload.domainId,
+      inboxId: context.payload.inboxId,
+    });
+  }
+}
+```
+
+---
+
 ## Semantic Search (Coming Soon)
 
 Search across all emails in your organization using natural language queries.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commune-ai",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Email infrastructure for AI agents - webhooks, threads, history, and semantic search",
   "type": "module",
   "main": "dist/index.js",