# @aimail/mail-core 中文文档

规范地址：https://npmcn.com/package/%40aimail/mail-core/

版本：0\.1\.55
npm 元数据更新时间：2026-10-19T17:44:39.836Z
中文译文更新时间：2026-11-06T16:48:47.512Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aimail/mail-core
原文对照：https://npmcn.com/package/%40aimail/mail-core/?lang=original
项目主页：https://github.com/metercai/aimail#readme
源码仓库：https://github.com/metercai/aimail

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：334 kB，66 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-08-19T10:00:18.929Z
- 最新版本发布：2026-10-19T17:44:39.395Z
- 近 30 天下载量：2707（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：74（近 12 个月 74 个）

## 中文简介

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

## 安装

```sh
npm install @aimail/mail-core
```

也可以使用：`pnpm add @aimail/mail-core`、`yarn add @aimail/mail-core`、`bun add @aimail/mail-core`

## README

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

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

[![npm](https://img.shields.io/npm/v/@aimail/mail-core)](https://www.npmjs.com/package/@aimail/mail-core)

## 安装

```bash
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}`) (中文(简体) ).

## 使用量

```ts
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/邮件](https://npmcn.com/package/%40aimail/mail/README.md) ——配置解析帮助.
-   [双管单管](https://github.com/metercai/aimail) ——CLI,Python SDK,适配器.

## 常见问题

### @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 和提交记录判断。