Gmail Pub/Sub -> OpenClaw

目标:Gmail watch -> Pub/Sub 推送 -> gog gmail watch serve -> OpenClaw webhook。

前置条件

  • 已安装 gcloud 并登录(安装指南)。
  • 已安装 gog(gogcli)并已授权 Gmail 账户(gogcli.sh)。
  • 已启用 OpenClaw Hook(请参阅 Webhook)。
  • tailscale 已登录(tailscale.com)。支持的设置使用 Tailscale Funnel 作为公共 HTTPS 端点。 其他隧道服务可以工作,但需要自行配置,不受支持。 目前,我们支持 Tailscale。

示例 Hook 配置(启用 Gmail 预设映射):

{
  hooks: {
    enabled: true,
    token: "OPENCLAW_HOOK_TOKEN",
    path: "/hooks",
    presets: ["gmail"],
  },
}

要将 Gmail 摘要投送到聊天界面,使用设置 deliver + 可选 channel/to 的映射覆盖预设:

{
  hooks: {
    enabled: true,
    token: "OPENCLAW_HOOK_TOKEN",
    presets: ["gmail"],
    mappings: [
      {
        match: { path: "gmail" },
        action: "agent",
        wakeMode: "now",
        name: "Gmail",
        sessionKey: "hook:gmail:{{messages[0].id}}",
        messageTemplate: "New email from {{messages[0].from}}\nSubject: {{messages[0].subject}}\n{{messages[0].snippet}}\n{{messages[0].body}}",
        model: "openai/gpt-5.2-mini",
        deliver: true,
        channel: "last",
        // to: "+15551234567"
      },
    ],
  },
}

如果需要固定频道,请设置 channel + to。否则 channel: "last" 使用最后投递路由(回退到 WhatsApp)。

要为 Gmail 运行强制使用更便宜的模型,请在映射中设置 modelprovider/model 或别名)。如果强制执行 agents.defaults.models,请在那里包含它。

要为 Gmail Hook 专门设置默认模型和思考级别,请在配置中添加 hooks.gmail.model / hooks.gmail.thinking

{
  hooks: {
    gmail: {
      model: "openrouter/meta-llama/llama-3.3-70b-instruct:free",
      thinking: "off",
    },
  },
}

注意:

  • 映射中每个 Hook 的 model/thinking 仍然覆盖这些默认值。
  • 回退顺序:hooks.gmail.modelagents.defaults.model.fallbacks → 主模型(auth/rate-limit/timeouts)。
  • 如果设置了 agents.defaults.models,则 Gmail 模型必须在允许列表中。
  • 默认情况下,Gmail Hook 内容会使用 external-content 安全边界包装。 要禁用(危险),请设置 hooks.gmail.allowUnsafeExternalContent: true

要进一步自定义负载处理,请添加 hooks.mappings 或 JS/TS 转换模块 在 ~/.openclaw/hooks/transforms 下(请参阅 Webhook)。

向导(推荐)

使用 OpenClaw 助手连接所有内容(通过 brew 在 macOS 上安装依赖):

openclaw webhooks gmail setup \
  --account [email protected]

默认值:

  • 使用 Tailscale Funnel 作为公共推送端点。
  • 写入 hooks.gmail 配置用于 openclaw webhooks gmail run
  • 启用 Gmail Hook 预设(hooks.presets: ["gmail"])。

路径说明:当启用 tailscale.mode 时,OpenClaw 自动设置 hooks.gmail.serve.path/,并将公共路径保留在 hooks.gmail.tailscale.path(默认 /gmail-pubsub),因为 Tailscale 在代理之前会剥离设置路径前缀。 如果需要后端接收带前缀的路径,请设置 hooks.gmail.tailscale.target(或 --tailscale_target)为完整 URL,如 http://127.0.0.1:8788/gmail-pubsub 并匹配 hooks.gmail.serve.path

想要自定义端点?请使用 --push-endpoint <url>--tailscale off

平台说明:在 macOS 上,向导通过 Homebrew 安装 gcloudgogclitailscale;在 Linux 上请先手动安装。

网关自动启动(推荐):

  • hooks.enabled=true 且设置了 hooks.gmail.account 时,网关启动 gog gmail watch serve 并在启动时自动续订 watch。
  • 设置 OPENCLAW_SKIP_GMAIL_WATCHER=1 选择退出(如果您自己运行守护进程,这很有用)。
  • 不要同时运行手动守护进程,否则您会遇到 listen tcp 127.0.0.1:8788: bind: address already in use

手动守护进程(启动 gog gmail watch serve + 自动续订):

openclaw webhooks gmail run

一次性设置

  1. 选择 拥有 OAuth 客户端的 GCP 项目,由 gog 使用。
gcloud auth login
gcloud config set project <project-id>

注意:Gmail watch 要求 Pub/Sub 主题与 OAuth 客户端位于同一项目中。

  1. 启用 API:
gcloud services enable gmail.googleapis.com pubsub.googleapis.com
  1. 创建主题:
gcloud pubsub topics create gog-gmail-watch
  1. 允许 Gmail 推送发布:
gcloud pubsub topics add-iam-policy-binding gog-gmail-watch \
  --member=serviceAccount:[email protected] \
  --role=roles/pubsub.publisher

启动 Watch

gog gmail watch start \
  --account [email protected] \
  --label INBOX \
  --topic projects/<project-id>/topics/gog-gmail-watch

保存输出的 history_id(用于调试)。

运行推送处理器

本地示例(共享令牌认证):

gog gmail watch serve \
  --account [email protected] \
  --bind 127.0.0.1 \
  --port 8788 \
  --path /gmail-pubsub \
  --token <shared> \
  --hook-url http://127.0.0.1:18789/hooks/gmail \
  --hook-token OPENCLAW_HOOK_TOKEN \
  --include-body \
  --max-bytes 20000

注意:

  • --token 保护推送端点(x-gog-token?token=)。
  • --hook-url 指向 OpenClaw /hooks/gmail(已映射;独立运行 + 摘要到主会话)。
  • --include-body--max-bytes 控制发送到 OpenClaw 的内容片段。

推荐:openclaw webhooks gmail run 包装相同流程并自动续订 watch。

公开处理器(高级,不支持)

如果您需要非 Tailscale 隧道,请手动连接并在推送订阅中使用公共 URL(不支持,无防护):

cloudflared tunnel --url http://127.0.0.1:8788 --no-autoupdate

使用生成的 URL 作为推送端点:

gcloud pubsub subscriptions create gog-gmail-watch-push \
  --topic gog-gmail-watch \
  --push-endpoint "https://<public-url>/gmail-pubsub?token=<shared>"

生产环境:使用稳定的 HTTPS 端点并配置 Pub/Sub OIDC JWT,然后运行:

gog gmail watch serve --verify-oidc --oidc-email <svc@...>

测试

向监视的收件箱发送消息:

gog gmail send \
  --account [email protected] \
  --to [email protected] \
  --subject "watch test" \
  --body "ping"

检查 watch 状态和历史:

gog gmail watch status --account [email protected]
gog gmail history --account [email protected] --since <historyId>

故障排除

  • Invalid topicName:项目不匹配(主题不在 OAuth 客户端项目中)。
  • User not authorized:主题上缺少 roles/pubsub.publisher
  • 空消息:Gmail 推送仅提供 historyId;通过 gog gmail history 获取。

清理

gog gmail watch stop --account [email protected]
gcloud pubsub subscriptions delete gog-gmail-watch-push
gcloud pubsub topics delete gog-gmail-watch