@aimail/mail-core

中文文档
0.1.55发布于 2026/10/20MITTypeScriptES Module构建来源已验证近 30 天下载 2707

AIMail 共享 TS 核心:网关客户端,工具功能,入门预处理链(framework-agnostic;单运行时间dep:typebox).

中文使用文档
文档目录4 节
  1. 安装
  2. 它会做什么
  3. 使用量
  4. 相关

@aimail/mail-core (中文(简体) )

TypeScript 的框架不可知AIMail核心:网关客户端,工具,完整 输入预处理链,以及 agentmail.json 读/写。 直接导入 从任何 TS 代理运行时间( dsh, OpenClaw, pi, 或您自己的) .

npm

安装

pnpm add @aimail/mail-core

点 AIMAIL_HOME (默认) ~/.aimail),按地址排列 agentmail.json 捆绑现场.

它会做什么

  • GatewayClient ——认证的网关 HTTP 客户端(发送/上传/下载/) 白列表 / 联系人 / 代理状态 / 线程 / 板 ; 外出请求 页:1 X-AIMail-Agent 头和 V1 HMAC 签名 .
  • 工具 - 发送、联系人、联系人简介、电子邮件摘要、搜索和董事会 API, 通过曝光 MAIL_TOOLS: 名称、描述、类型框参数 形状和处理器在一个阵列中.
  • 入境—— processInboundMail 运行共享预处理链(接收和 发送器浓缩、人员正常化、DM/minion检测、附件 a. 下载、入境记录和拦截乒乓球探测器; verifySignature 检查Webhook HMAC.
  • 配置 - loadConfigByEmail 编号 : loadConfigByAgentId 编号 : loadConfigBySessionId, (中文(简体) ), saveAgentConfig, (中文(简体) ), updateAgentConfig。每个地址 agentmail.json 这是 只有身份来源.
  • 身份 - setAgentIdentity 编号 : setAgentModel 设定 X-AIMail-Agent (单位:千美元){platform}/{version}+{model}) (中文(简体) ).

使用量

import { sendMail, processInboundMail, verifySignature, MAIL_TOOLS } from '@aimail/mail-core'

const result = await sendMail({ systemId, email }, { to, subject, body })

if (verifySignature(rawBody, sig, webhookSecret)) {
  const enriched = await processInboundMail(payload, headers, { systemId, email })
  // null = ping/pong already answered in place; otherwise hand it to the agent
}

for (const tool of MAIL_TOOLS) { /* bind name / description / params / handler */ }

版本与发布记录

@aimail/mail-core 共发布 74 个版本,首次发布于 2026/08/19;过去 12 个月发布了 74 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.55latest2026/10/2019 天前
0.1.542026/10/1820 天前
0.1.532026/10/1721 天前
0.1.522026/10/1622 天前
0.1.512026/10/1424 天前
0.1.502026/10/1127 天前

其他发布通道:rc → 0.1.12-rc.2。

关于 @aimail/mail-core 的常见问题

@aimail/mail-core 是什么?

AIMail 共享 TS 核心:网关客户端,工具功能,入门预处理链(framework-agnostic;单运行时间dep:typebox).

如何安装 @aimail/mail-core?

在项目目录运行 npm install @aimail/mail-core,或使用 pnpm add / yarn add / bun add。

@aimail/mail-core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@aimail/mail-core 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@aimail/mail-core 可以商用吗?

@aimail/mail-core 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@aimail/mail-core 的下载量有多少?

根据 npm 官方下载统计,@aimail/mail-core 在 2026/10/05 – 2026/11/03 这 30 天内被下载 2,707 次,日均约 90 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@aimail/mail-core 还在维护吗?

最新版本 0.1.55 发布于 2026/10/20(19 天前);至今共发布 74 个版本,其中过去 12 个月发布了 74 个;首次发布于 2026/08/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。