---
id: ssh-gws-gmail-watch
name: "gws-gmail-watch"
url: https://skills.yangsir.net/skill/ssh-gws-gmail-watch
author: googleworkspace
domain: ai-productivity-automation
tags: ["gmail-api", "email-event-monitoring", "webhook-integration", "real-time-notifications", "google-workspace"]
install_count: 19300
rating: 4.60 (276 reviews)
github: https://github.com/googleworkspace/cli
---

# gws-gmail-watch

> 用于监听Gmail收件箱中的新邮件，并将其内容以NDJSON格式进行流式传输。

**Stats**: 19,300 installs · 4.6/5 (276 reviews)

## Before / After 对比

### 中文

## Readme

# gmail +watch

> **PREREQUISITE:** Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.

Watch for new emails and stream them as NDJSON

## Usage

```bash
gws gmail +watch
```

## Flags

| Flag | Required | Default | Description |
|------|----------|---------|-------------|
| `--project` | — | — | GCP project ID for Pub/Sub resources |
| `--subscription` | — | — | Existing Pub/Sub subscription name (skip setup) |
| `--topic` | — | — | Existing Pub/Sub topic with Gmail push permission already granted |
| `--label-ids` | — | — | Comma-separated Gmail label IDs to filter (e.g., INBOX,UNREAD) |
| `--max-messages` | — | 10 | Max messages per pull batch |
| `--poll-interval` | — | 5 | Seconds between pulls |
| `--msg-format` | — | full | Gmail message format: full, metadata, minimal, raw |
| `--once` | — | — | Pull once and exit |
| `--cleanup` | — | — | Delete created Pub/Sub resources on exit |
| `--output-dir` | — | — | Write each message to a separate JSON file in this directory |

## Examples

```bash
gws gmail +watch --project my-gcp-project
gws gmail +watch --project my-project --label-ids INBOX --once
gws gmail +watch --subscription projects/p/subscriptions/my-sub
gws gmail +watch --project my-project --cleanup --output-dir ./emails
```

## Tips

- Gmail watch expires after 7 days — re-run to renew.
- Without --cleanup, Pub/Sub resources persist for reconnection.
- Press Ctrl-C to stop gracefully.

## See Also

- [gws-shared](../gws-shared/SKILL.md) — Global flags and auth
- [gws-gmail](../gws-gmail/SKILL.md) — All send, read, and manage email commands


---
*Source: https://skills.yangsir.net/skill/ssh-gws-gmail-watch*
*Markdown mirror: https://skills.yangsir.net/api/skill/ssh-gws-gmail-watch/markdown*