@zhin.js/adapter-email 5.0.0 → 5.0.2

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @zhin.js/adapter-email
 
+## 5.0.2
+
+### Patch Changes
+
+- Updated dependencies [afc0e66]
+- Updated dependencies [2e41ad5]
+- Updated dependencies [9f57124]
+  - @zhin.js/core@1.5.2
+  - @zhin.js/adapter@1.1.5
+  - @zhin.js/im-contract@1.0.1
+  - @zhin.js/plugin-runtime@1.1.3
+  - zhin.js@6.0.2
+
+## 5.0.1
+
+### Patch Changes
+
+- Updated dependencies [c8f4d45]
+  - @zhin.js/plugin-runtime@1.1.2
+  - @zhin.js/adapter@1.1.4
+  - @zhin.js/core@1.5.1
+  - zhin.js@6.0.1
+
 ## 5.0.0
 
 ### Patch Changes

package/README.md

@@ -23,8 +23,8 @@ pnpm add @zhin.js/adapter-email
 - `@zhin.js/plugin-runtime` — `plugin.ts`（`definePlugin`）
 - 配置经插件 `schema.json` 落到 `plugins.<instanceKey>`（`smtp` / `imap`）
 
-入站：`gateway.receive({ adapter, target: fromEmail, content: text, sender, metadata })`  
-出站：`send({ target, payload })` → nodemailer（payload 已由 gateway/core 渲染；无 segment-mapper）
+入站：`gateway.receive({ conversation, message, content: text, sender, metadata })`（`conversation` 为 kind=private、id=发件人地址的 ConversationRef）  
+出站：`send({ conversation, payload })` → nodemailer（收件人取 `conversation.id`；payload 已由 gateway/core 渲染；无 segment-mapper）
 
 ## 前置条件
 

package/lib/endpoint.d.ts

@@ -1,4 +1,4 @@
-import type { EndpointInstance } from '@zhin.js/adapter';
+import type { EndpointInstance, EndpointSendRequest } from '@zhin.js/adapter';
 import type { MessageGateway } from '@zhin.js/core/runtime';
 import type { CapabilityId } from '@zhin.js/plugin-runtime';
 import { type EmailMessage, type ResolvedEmailConfig } from './protocol.js';
@@ -21,10 +21,7 @@ export declare class EmailEndpoint implements EndpointInstance {
     open(): void;
     close(): void;
     stop(): Promise<void>;
-    send({ target, payload }: {
-        readonly target: string;
-        readonly payload: unknown;
-    }): Promise<string>;
+    send({ conversation, payload }: EndpointSendRequest): Promise<string>;
     /** Test / internal: admit a parsed mail when the endpoint is open. */
     admit(email: EmailMessage): void;
 }

package/lib/endpoint.js

@@ -5,7 +5,7 @@ import { mkdir, writeFile } from 'node:fs/promises';
 import * as path from 'node:path';
 import { simpleParser } from 'mailparser';
 import { formatCompact, getLogger } from '@zhin.js/logger';
-import { formatInboundContent, formatInboundSegments, formatOutboundMail, parseEmailMessage, senderDisplayName, } from './protocol.js';
+import { emailInboundConversation, formatInboundContent, formatInboundSegments, formatOutboundMail, parseEmailMessage, senderDisplayName, } from './protocol.js';
 import { defaultCreateImap, defaultCreateSmtp, } from './transport.js';
 const logger = getLogger('email');
 /**
@@ -89,9 +89,10 @@ export class EmailEndpoint {
         }
         logger.debug(formatCompact({ op: 'disconnect', endpoint: this.#options.config.name }));
     }
-    async send({ target, payload }) {
+    async send({ conversation, payload }) {
         if (!this.#smtp)
             throw new Error('SMTP transporter not initialized');
+        const target = conversation.id;
         const mailOptions = formatOutboundMail(payload, {
             from: this.#options.config.smtp.auth.user,
             to: target,
@@ -116,13 +117,13 @@ export class EmailEndpoint {
         const savedAttachments = await this.#downloadAttachments(email);
         const content = formatInboundContent(email);
         const sender = email.from;
+        const conversation = emailInboundConversation(String(this.#options.id), email);
         await this.#options.gateway.receive({
-            adapter: this.#options.id,
-            target: sender,
+            conversation,
+            ...(email.messageId ? { message: { conversation, id: email.messageId } } : {}),
             content,
             segments: formatInboundSegments(email, savedAttachments),
             sender: senderDisplayName(sender),
-            id: email.messageId || undefined,
             metadata: Object.freeze({
                 subject: email.subject,
                 to: email.to,

package/lib/index.d.ts

@@ -1,3 +1,3 @@
-export { addressListText, formatInboundContent, formatInboundSegments, formatOutboundMail, htmlToText, parseEmailMessage, resolveEmailConfig, senderDisplayName, type EmailAdapterConfig, type EmailAttachmentsConfig, type EmailMessage, type EmailWireSegment, type ImapConfig, type ResolvedEmailConfig, type SavedEmailAttachment, type SmtpConfig, } from './protocol.js';
+export { addressListText, emailInboundConversation, formatInboundContent, formatInboundSegments, formatOutboundMail, htmlToText, parseEmailMessage, resolveEmailConfig, senderDisplayName, type EmailAdapterConfig, type EmailAttachmentsConfig, type EmailMessage, type EmailWireSegment, type ImapConfig, type ResolvedEmailConfig, type SavedEmailAttachment, type SmtpConfig, } from './protocol.js';
 export { EmailEndpoint, type EmailEndpointOptions, } from './endpoint.js';
 export { defaultCreateImap, defaultCreateSmtp, type EmailImapFetchMessage, type EmailImapTransport, type EmailSmtpTransport, } from './transport.js';

package/lib/index.js

@@ -1,3 +1,3 @@
-export { addressListText, formatInboundContent, formatInboundSegments, formatOutboundMail, htmlToText, parseEmailMessage, resolveEmailConfig, senderDisplayName, } from './protocol.js';
+export { addressListText, emailInboundConversation, formatInboundContent, formatInboundSegments, formatOutboundMail, htmlToText, parseEmailMessage, resolveEmailConfig, senderDisplayName, } from './protocol.js';
 export { EmailEndpoint, } from './endpoint.js';
 export { defaultCreateImap, defaultCreateSmtp, } from './transport.js';

package/lib/protocol.d.ts

@@ -4,6 +4,7 @@
  */
 import type { Attachment } from 'mailparser';
 import type { Segment } from '@zhin.js/core/runtime';
+import type { ConversationRef } from '@zhin.js/im-contract';
 export interface SmtpConfig {
     readonly host: string;
     readonly port: number;
@@ -101,6 +102,11 @@ export interface SavedEmailAttachment {
  * 未下载的附件（disabled / 被过滤）只保留 content 里的占位文本。
  */
 export declare function formatInboundSegments(email: EmailMessage, savedAttachments?: readonly SavedEmailAttachment[]): Segment[];
+/**
+ * 入站归一化 → ConversationRef：Email 无群/频道概念，所有入站邮件都是
+ * 与发件人地址的 private 会话（id = 发件人地址）。
+ */
+export declare function emailInboundConversation(endpointId: string, email: EmailMessage): ConversationRef;
 export declare function senderDisplayName(from: string): string;
 /**
  * nodemailer 附件的最小形状：url/path 走 `path`（URL 由 nodemailer 拉流、

package/lib/protocol.js

@@ -120,6 +120,17 @@ export function formatInboundSegments(email, savedAttachments = []) {
     }
     return out;
 }
+/**
+ * 入站归一化 → ConversationRef：Email 无群/频道概念，所有入站邮件都是
+ * 与发件人地址的 private 会话（id = 发件人地址）。
+ */
+export function emailInboundConversation(endpointId, email) {
+    return {
+        endpoint: { id: endpointId, adapter: endpointId.split('\0')[0] ?? endpointId },
+        kind: 'private',
+        id: email.from,
+    };
+}
 export function senderDisplayName(from) {
     const name = from.split('<')[0]?.trim();
     return name || from;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/adapter-email",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "type": "module",
   "description": "Zhin.js Email adapter for Plugin Runtime (SMTP/IMAP)",
   "main": "./lib/index.js",
@@ -9,16 +9,17 @@
     "imap": "^0.8.19",
     "mailparser": "^3.9.14",
     "nodemailer": "^9.0.3",
-    "@zhin.js/adapter": "1.1.3",
-    "@zhin.js/core": "1.5.0",
+    "@zhin.js/adapter": "1.1.5",
+    "@zhin.js/core": "1.5.2",
+    "@zhin.js/im-contract": "1.0.1",
     "@zhin.js/logger": "1.0.75",
-    "@zhin.js/plugin-runtime": "1.1.1"
+    "@zhin.js/plugin-runtime": "1.1.3"
   },
   "peerDependencies": {
-    "@zhin.js/adapter": "1.1.3",
-    "@zhin.js/core": "1.5.0",
-    "@zhin.js/plugin-runtime": "1.1.1",
-    "zhin.js": "6.0.0"
+    "@zhin.js/adapter": "1.1.5",
+    "@zhin.js/core": "1.5.2",
+    "@zhin.js/plugin-runtime": "1.1.3",
+    "zhin.js": "6.0.2"
   },
   "peerDependenciesMeta": {
     "zhin.js": {

package/src/endpoint.ts

@@ -4,11 +4,12 @@
 import { mkdir, writeFile } from 'node:fs/promises';
 import * as path from 'node:path';
 import { simpleParser } from 'mailparser';
-import type { EndpointInstance } from '@zhin.js/adapter';
+import type { EndpointInstance, EndpointSendRequest } from '@zhin.js/adapter';
 import type { MessageGateway } from '@zhin.js/core/runtime';
 import { formatCompact, getLogger } from '@zhin.js/logger';
 import type { CapabilityId } from '@zhin.js/plugin-runtime';
 import {
+  emailInboundConversation,
   formatInboundContent,
   formatInboundSegments,
   formatOutboundMail,
@@ -120,8 +121,9 @@ export class EmailEndpoint implements EndpointInstance {
     logger.debug(formatCompact({ op: 'disconnect', endpoint: this.#options.config.name }));
   }
 
-  async send({ target, payload }: { readonly target: string; readonly payload: unknown }): Promise<string> {
+  async send({ conversation, payload }: EndpointSendRequest): Promise<string> {
     if (!this.#smtp) throw new Error('SMTP transporter not initialized');
+    const target = conversation.id;
     const mailOptions = formatOutboundMail(payload, {
       from: this.#options.config.smtp.auth.user,
       to: target,
@@ -147,13 +149,13 @@ export class EmailEndpoint implements EndpointInstance {
     const savedAttachments = await this.#downloadAttachments(email);
     const content = formatInboundContent(email);
     const sender = email.from;
+    const conversation = emailInboundConversation(String(this.#options.id), email);
     await this.#options.gateway.receive({
-      adapter: this.#options.id,
-      target: sender,
+      conversation,
+      ...(email.messageId ? { message: { conversation, id: email.messageId } } : {}),
       content,
       segments: formatInboundSegments(email, savedAttachments),
       sender: senderDisplayName(sender),
-      id: email.messageId || undefined,
       metadata: Object.freeze({
         subject: email.subject,
         to: email.to,

package/src/index.ts

@@ -1,5 +1,6 @@
 export {
   addressListText,
+  emailInboundConversation,
   formatInboundContent,
   formatInboundSegments,
   formatOutboundMail,

package/src/protocol.ts

@@ -6,6 +6,7 @@
 import type { Attachment } from 'mailparser';
 import { htmlToPlainTextWithBlockBreaks, isMediaRef, type MediaRef } from '@zhin.js/core';
 import type { Segment } from '@zhin.js/core/runtime';
+import type { ConversationRef } from '@zhin.js/im-contract';
 import { formatCompact, getLogger } from '@zhin.js/logger';
 
 const logger = getLogger('email');
@@ -227,6 +228,18 @@ export function formatInboundSegments(
   return out;
 }
 
+/**
+ * 入站归一化 → ConversationRef：Email 无群/频道概念，所有入站邮件都是
+ * 与发件人地址的 private 会话（id = 发件人地址）。
+ */
+export function emailInboundConversation(endpointId: string, email: EmailMessage): ConversationRef {
+  return {
+    endpoint: { id: endpointId, adapter: endpointId.split('\0')[0] ?? endpointId },
+    kind: 'private',
+    id: email.from,
+  };
+}
+
 export function senderDisplayName(from: string): string {
   const name = from.split('<')[0]?.trim();
   return name || from;