gws-gmail-watch
SolidGmail: Watch for new emails and stream them as NDJSON.
AI & Automation 26,697 stars
1403 forks Updated 2 weeks ago Apache-2.0
Install
Quality Score: 92/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
Skill Content
# 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.
##...
Details
- Author
- googleworkspace
- Repository
- googleworkspace/cli
- Created
- 2 months ago
- Last Updated
- 2 weeks ago
- Language
- Rust
- License
- Apache-2.0
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
Web & Frontend Listed
gws-gmail-watch
This skill should be used when the user says "watch for new emails", "stream incoming Gmail", "monitor my inbox for new messages", "set up a Gmail listener", "pipe incoming emails to a script", or wants to watch a Gmail mailbox and stream new messages in real time. Covers Pub/Sub integration, label filtering, and writing messages to a directory.
3 Updated 2 days ago
radesjardins AI & Automation Solid
gws-gmail
Gmail: Send, read, and manage email.
26,697 Updated 2 weeks ago
googleworkspace AI & Automation Listed
gws-gmail
Gmail: Send, read, and manage email.
335 Updated today
aiskillstore AI & Automation Listed
gws-gmail
Gmail: Send, read, and manage email.
21 Updated 4 days ago
project-nomos AI & Automation Solid
gws-events-subscribe
Google Workspace Events: Subscribe to Workspace events and stream them as NDJSON.
26,697 Updated 2 weeks ago
googleworkspace