# @framers/agentos-ext-email-gmail 中文文档

规范地址：https://npmcn.com/package/%40framers/agentos-ext-email-gmail/

版本：0\.1\.9
npm 元数据更新时间：2026-11-11T07:56:12.357Z
中文译文更新时间：2026-11-15T12:28:05.952Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40framers/agentos-ext-email-gmail
原文对照：https://npmcn.com/package/%40framers/agentos-ext-email-gmail/?lang=original
项目主页：https://github.com/framerslab/agentos-extensions/tree/master/registry/curated/productivity/gmail#readme
源码仓库：https://github.com/framerslab/agentos-extensions

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

- 包体积（解压后）：107 kB，40 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- peer 依赖：@framers/agentos \>=0\.10\.40
- 首次发布：2026-02-08T04:22:52.905Z
- 最新版本发布：2026-11-11T07:56:11.811Z
- 近 30 天下载量：20228（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

AgentOS的 Gmail 集成 — 通过 Google Gmail API 的 CRUD 电子邮件

## 安装

```sh
npm install @framers/agentos-ext-email-gmail
```

也可以使用：`pnpm add @framers/agentos-ext-email-gmail`、`yarn add @framers/agentos-ext-email-gmail`、`bun add @framers/agentos-ext-email-gmail`

## README

# Gmail 电子邮件

此包通过 Google Gmail API 提供代理信件列表、读取、发送、回复、搜索和标签检查 `googleapis` 和OAuth2号卫星.

## 安装

```bash
npm install @framers/agentos-ext-email-gmail
```

同伴依赖 : `@framers/agentos` `>=0.10.40`。 。 。 .

## 使用量

```ts
import { AgentOS } from '@framers/agentos';

const agentos = await AgentOS.create({
  extensionManifest: {
    packs: [
      {
        package: '@framers/agentos-ext-email-gmail',
        options: {
          clientId: process.env.GOOGLE_CLIENT_ID || process.env.GMAIL_CLIENT_ID,
          clientSecret: process.env.GOOGLE_CLIENT_SECRET || process.env.GMAIL_CLIENT_SECRET,
          refreshToken: process.env.GOOGLE_REFRESH_TOKEN || process.env.GMAIL_REFRESH_TOKEN,
        },
      },
    ],
  },
});
```

## 配置

| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
| --- | --- | --- | --- | --- |
| `clientId` | `google.clientId` | `GOOGLE_CLIENT_ID`,则 `GMAIL_CLIENT_ID` | 对 | 无默认 |
| `clientSecret` | `google.clientSecret` | `GOOGLE_CLIENT_SECRET`,则 `GMAIL_CLIENT_SECRET` | 对 | 无默认 |
| `refreshToken` | `google.refreshToken` | `GOOGLE_REFRESH_TOKEN`,则 `GMAIL_REFRESH_TOKEN` | 对 | 无默认 |
| `priority` |  |  | 没有 | `50` |
| `secrets` |  |  | 没有 | 无地图 |
| A. 背景情况 `logger` |  |  | 没有 | 无日志 |

在非空证书选项之前 `options.secrets`,然后按显示的顺序进行环境回落。 日志接收激活和停用信息 .

## 工具

| 工具 | 它会做什么 |
| --- | --- |
| `gmailListMessages` | 列出带有查询、标签和结果过滤器的信件摘要. |
| `gmailReadMessage` | 读取信件的主题,发件人,收件人,日期,正文和标签. |
| `gmailSendMessage` | 与 To, CC 和 BCC 收件人一起发送纯文本电子邮件 . |
| `gmailReplyMessage` | 带回信头和 a 的线索内的答复 `Re:` 主题前缀. |
| `gmailSearchMessages` | 使用 Gmail 搜索语法搜索信件 . |
| `gmailListLabels` | 列出带有类型和信件计数的标签. |

### `gmailListMessages`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `query` | 字符串 | 没有 | Gmail搜索查询(例如"is:unread","从:alice@example.com","subject:invoice"). 使用标准的Gmail搜索语法. |
| `labelIds` | 字符串数组 | 没有 | 通过标签ID来过滤(例如 \["INBOX","UNREAD"\]) |
| `maxResults` | 编号 | 没有 | 要返回的信件的最大数量( 默认: 10, 最大: 100) |

### `gmailReadMessage`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `messageId` | 字符串 | 对 | 要读取的 Gmail 信件ID |

### `gmailSendMessage`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `to` | 字符串 | 对 | 收件人电子邮件地址( 多个地址已合并分离) |
| `subject` | 字符串 | 对 | 电子邮件主题行 |
| `body` | 字符串 | 对 | 电子邮件正文文本( 平面文本) |
| `cc` | 字符串 | 没有 | CC 接收者( comma- 分隔的电子邮件地址) |
| `bcc` | 字符串 | 没有 | BCC 接收者( 已合并的电子邮件地址) |

### `gmailReplyMessage`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `messageId` | 字符串 | 对 | 要回复的 Gmail 信件代号 |
| `body` | 字符串 | 对 | 答复机构案文(全文) |

### `gmailSearchMessages`

| 参数 | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `query` | 字符串 | 对 | 使用Gmail搜索语法的Gmail搜索查询(例如"从:alice@example.com","subject:invoice has:attachment","is:unread after:2024/06/01") |
| `maxResults` | 编号 | 没有 | 要返回的最大结果数( 默认: 10, 最大: 100) |

### `gmailListLabels`

输入方案没有参数.

## 页:1

软件包需要节点.js `>=22`丢失了OAuth的证书 使工厂投出。 激活初始化 OAuth 客户端带有刷新符;服务操作需要初始化. 该包还将服务登记为: `gmailService` 与善良 `productivity`。 。 。 .

从认证账户发送并回复电子邮件 。 答复的原件 `From` 页眉,使用原始线程,并设定 `In-Reply-To` 财务报告和审定财务报表 `References` 从其消息ID头。 尸体作为纯文本发送.

列表和搜索夹 `maxResults` 从 `1` 改为 `100`。在返回摘要之前,它们会获取完整的信息。 从 HTML 读取纯文本或条纹标记。 标签细节失败返回基本标签而不计算消息数 。 工具失败返回 `success: false` 还有一个 `error` 留言.

## 释放

新版本发表于 [架设层/剂-外延](https://github.com/framerslab/agentos-extensions) 由 GitHub Actions 通过 npm 信任的出版, 并附有出处声明 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @framers/agentos-ext-email-gmail 是什么？

AgentOS的 Gmail 集成 — 通过 Google Gmail API 的 CRUD 电子邮件

### 如何安装 @framers/agentos-ext-email-gmail？

在项目目录运行 npm install @framers/agentos-ext-email-gmail，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@framers/agentos（\>=0\.10\.40）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @framers/agentos-ext-email-gmail 支持 TypeScript 吗？

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

### @framers/agentos-ext-email-gmail 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @framers/agentos-ext-email-gmail 需要什么版本的 Node\.js？

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

### @framers/agentos-ext-email-gmail 可以商用吗？

@framers/agentos-ext-email-gmail 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @framers/agentos-ext-email-gmail 的下载量有多少？

根据 npm 官方下载统计，@framers/agentos-ext-email-gmail 在 2026/10/16 – 2026/11/14 这 30 天内被下载 20,228 次，日均约 674 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @framers/agentos-ext-email-gmail 还在维护吗？

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