> gws-gmail-watch

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

fetch
$curl "https://skillshub.wtf/googleworkspace/cli/gws-gmail-watch?format=md"
SKILL.mdgws-gmail-watch

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

gws gmail +watch

Flags

FlagRequiredDefaultDescription
--projectGCP project ID for Pub/Sub resources
--subscriptionExisting Pub/Sub subscription name (skip setup)
--topicExisting Pub/Sub topic with Gmail push permission already granted
--label-idsComma-separated Gmail label IDs to filter (e.g., INBOX,UNREAD)
--max-messages10Max messages per pull batch
--poll-interval5Seconds between pulls
--msg-formatfullGmail message format: full, metadata, minimal, raw
--oncePull once and exit
--cleanupDelete created Pub/Sub resources on exit
--output-dirWrite each message to a separate JSON file in this directory

Examples

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

┌ stats

installs/wk0
░░░░░░░░░░
github stars21.3K
██████████
first seenMar 18, 2026
└────────────

┌ repo

googleworkspace/cli
by googleworkspace
└────────────

┌ tags

└────────────