Gmail 电子邮件
此包通过 Google Gmail API 提供代理信件列表、读取、发送、回复、搜索和标签检查 googleapis 和OAuth2号卫星.
安装
npm install @framers/agentos-ext-email-gmail
同伴依赖 : @framers/agentos >=0.10.40。 。 。 .
使用量
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","从:[email protected]","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搜索查询(例如"从:[email protected]","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 留言.
释放
新版本发表于 架设层/剂-外延 由 GitHub Actions 通过 npm 信任的出版, 并附有出处声明 .
许可证
阿帕奇 - 2.0