# fluxmail 中文文档

规范地址：https://npmcn.com/package/fluxmail/

版本：0\.21\.1
npm 元数据更新时间：2026-11-03T16:22:10.482Z
中文译文更新时间：2026-11-03T18:14:51.460Z
软件包许可：Elastic-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/fluxmail
原文对照：https://npmcn.com/package/fluxmail/?lang=original
项目主页：https://github.com/fluxmailai/fluxmail#readme
源码仓库：https://github.com/fluxmailai/fluxmail

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

- 包体积（解压后）：3.3 MB，444 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.22\.0
- 运行依赖：21 个
- 首次发布：2026-07-08T15:46:06.202Z
- 最新版本发布：2026-11-03T16:22:10.110Z
- 已发布版本数：31（近 12 个月 31 个）

## 中文简介

自托管电子邮件API，支持针对Gmail、Outlook和IMAP/SMTP的MCP和REST

## 安装

```sh
npm install fluxmail
```

也可以使用：`pnpm add fluxmail`、`yarn add fluxmail`、`bun add fluxmail`

## README

# Fluxmail

Fluxmail是代理和应用程序的自托管电子邮件基础设施。它连接Gmail、microsoft365、Outlook.com和IMAP/SMTP邮箱。代理使用MCP，应用程序和后端工作流使用版本化的REST API，操作员使用CLI连接邮箱、管理访问和运行服务。

## 安装

Fluxmail需要Node.js 22.22或更高版本。

```bash
npm install -g fluxmail
fluxmail setup --name "Your name" --email you@example.com
```

然后按照 [快速入门](https://fluxmail.ai/docs/quickstart) 连接邮箱，并选择使用Fluxmail的方式：MCP、REST API或CLI。

## 文档

-   [概述](https://fluxmail.ai/docs/overview)
-   [MCP的工具](https://fluxmail.ai/docs/tools)
-   [使用REST构建](https://fluxmail.ai/docs/build-with-rest)
-   [REST API](https://fluxmail.ai/docs/rest-api)
-   [权限](https://fluxmail.ai/docs/permissions)
-   [配置](https://fluxmail.ai/docs/configuration)
-   [CLI参考](https://fluxmail.ai/docs/cli)
-   [Gmail的设置](https://fluxmail.ai/docs/connect-gmail-to-mcp)
-   [Outlook设置](https://fluxmail.ai/docs/connect-outlook-to-mcp)
-   [IMAP的设置](https://fluxmail.ai/docs/connect-an-imap-mailbox)
-   [身份验证和实例](https://fluxmail.ai/docs/authentication-and-instances)

Fluxmail支持本地MCP客户端的studio。它的HTTP服务器为本地、Docker和远程部署提供了可流的HTTP MCP和REST。使用精确的包版本而不是 `@latest` 当你需要一个可重复的安装。

## 许可证

Fluxmail的源代码在 [弹性许可证2.0](https://github.com/fluxmailai/fluxmail/blob/main/LICENSE.md)。您可以使用，修改，创建衍生作品，并根据该许可重新分发。个人计划支持三个邮箱和一个没有付费密钥的成员。官方Pro、Business和Enterprise权利需要有效的Fluxmail许可证密钥。

## 常见问题

### fluxmail 是什么？

自托管电子邮件API，支持针对Gmail、Outlook和IMAP/SMTP的MCP和REST

### 如何安装 fluxmail？

在项目目录运行 npm install fluxmail，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 fluxmail，可以用 npx fluxmail 直接运行。

### fluxmail 支持 TypeScript 吗？

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

### fluxmail 支持 ESM 还是 CommonJS？

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

### fluxmail 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.22\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### fluxmail 可以商用吗？

fluxmail 使用 Elastic-2\.0 许可。声明的许可为 Elastic-2\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### fluxmail 还在维护吗？

最新版本 0\.21\.1 发布于 2026/11/04（今天）；至今共发布 31 个版本，其中过去 12 个月发布了 31 个；首次发布于 2026/07/08。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。