gws-gmail-watch

Original：🇺🇸 English
Translated

Gmail: Watch for new emails and stream them as NDJSON.

189installs
Sourcegoogleworkspace/cli
Added on

NPX Install

npx skill4agent add googleworkspace/cli gws-gmail-watch

Tags

Translated version includes tags in frontmatter
gmail-watchpubsub-integrationndjson-streamgws-cliemail-monitoring

SKILL.md Content

View Translation Comparison →

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

FlagRequiredDefaultDescription
--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
—10Max messages per pull batch
--poll-interval
—5Seconds between pulls
--msg-format
—fullGmail 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 — Global flags and auth
  • gws-gmail — All send, read, and manage email commands