@zhin.js/adapter-email 1.0.1 → 1.1.0

package/schema.json

@@ -0,0 +1,169 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "master": {
+      "type": [
+        "string",
+        "number"
+      ],
+      "description": "框架 master（email address；AI/工具权限、endpoint 管理）。endpoints[i].master 可逐项覆盖"
+    },
+    "trusted": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string",
+          "number"
+        ],
+        "description": "Trusted email address"
+      },
+      "description": "框架 trusted 用户列表（弱于 master）。endpoints[i].trusted 可逐项追加"
+    },
+    "endpoints": {
+      "type": "array",
+      "description": "多账号：一个插件实例挂多个 endpoint。每项与顶层字段同构（id 必填，其余覆盖顶层）",
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "master": {
+            "type": [
+              "string",
+              "number"
+            ],
+            "description": "本 endpoint 的框架 master（email address）；覆盖顶层 master"
+          },
+          "trusted": {
+            "type": "array",
+            "items": {
+              "type": [
+                "string",
+                "number"
+              ],
+              "description": "Trusted email address"
+            },
+            "description": "本 endpoint 的 trusted 列表"
+          },
+          "smtp": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "host": {
+                "type": "string"
+              },
+              "port": {
+                "type": "number"
+              },
+              "secure": {
+                "type": "boolean"
+              },
+              "auth": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "user": {
+                    "type": "string"
+                  },
+                  "pass": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "user",
+                  "pass"
+                ]
+              }
+            },
+            "required": [
+              "host",
+              "port",
+              "secure",
+              "auth"
+            ]
+          },
+          "imap": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "host": {
+                "type": "string"
+              },
+              "port": {
+                "type": "number"
+              },
+              "tls": {
+                "type": "boolean"
+              },
+              "user": {
+                "type": "string"
+              },
+              "password": {
+                "type": "string"
+              },
+              "checkInterval": {
+                "type": "number",
+                "default": 60000
+              },
+              "mailbox": {
+                "type": "string",
+                "default": "INBOX"
+              },
+              "markSeen": {
+                "type": "boolean",
+                "default": true
+              }
+            },
+            "required": [
+              "host",
+              "port",
+              "tls",
+              "user",
+              "password"
+            ]
+          },
+          "attachments": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "enabled": {
+                "type": "boolean",
+                "default": false
+              },
+              "downloadPath": {
+                "type": "string"
+              },
+              "maxFileSize": {
+                "type": "number"
+              },
+              "allowedTypes": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "id": {
+            "type": "string",
+            "description": "Email bot name"
+          }
+        },
+        "required": [
+          "id",
+          "smtp",
+          "imap"
+        ]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": [
+    "endpoints"
+  ]
+}

package/src/client.ts

@@ -0,0 +1,40 @@
+import type { EmailImapTransport, EmailSmtpTransport } from './transport.js';
+import { defineEndpointClient } from 'zhin.js/adapter';
+
+/** Live SMTP + IMAP client pair exposed to event handlers and plugins. */
+export class EmailClient {
+  constructor(
+    private readonly resolveSmtp: () => EmailSmtpTransport | null,
+    private readonly resolveImap: () => EmailImapTransport | null,
+  ) {}
+
+  get smtp(): EmailSmtpTransport {
+    const transport = this.resolveSmtp();
+    if (!transport) throw new Error('SMTP transporter not connected');
+    return transport;
+  }
+
+  get imap(): EmailImapTransport {
+    const transport = this.resolveImap();
+    if (!transport) throw new Error('IMAP client not connected');
+    return transport;
+  }
+
+  verify(): Promise<void> {
+    return this.smtp.verify();
+  }
+
+  sendMail(options: unknown): Promise<{ messageId?: string }> {
+    return this.smtp.sendMail(options);
+  }
+}
+
+export type EmailClientEventMap = Record<string, unknown>;
+
+declare module '@zhin.js/feature-kit' {
+  interface AdapterClientRegistry {
+    readonly email: { readonly client: EmailClient; readonly events: EmailClientEventMap };
+  }
+}
+
+export const emailClient = defineEndpointClient<EmailClient, EmailClientEventMap>('email');