
Skill
gws-gmail-watch
monitor and stream new Gmail messages
Description
Gmail: Watch for new emails and stream them as NDJSON.
SKILL.md
gmail +watch
PREREQUISITE: Read
../gws-shared/SKILL.mdfor auth, global flags, and security rules. If missing, rungws generate-skillsto create it.
Watch for new emails and stream them as NDJSON
Usage
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
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
More skills from the cli repository
View all 95 skillsgws-admin-reports
generate Google Workspace audit and usage reports
Jul 12AuditGoogle WorkspaceLogsReportinggws-calendar
manage Google Calendar events and schedules
Jul 12Google CalendarGoogle WorkspaceSchedulinggws-calendar-agenda
show upcoming Google Calendar events
Jul 12Google CalendarGoogle WorkspaceMeetingsgws-calendar-insert
create Google Calendar events
Jul 12Google CalendarGoogle WorkspaceSchedulinggws-chat
manage Google Chat spaces and messages
Jul 12Google WorkspaceMessaginggws-chat-send
send messages to Google Chat spaces
Jul 12Google WorkspaceMessaging
More from Google Workspace
View publishergws-classroom
manage Google Classroom rosters and coursework
cli
Jul 12EducationGoogle Workspacegws-docs
read and write Google Docs
cli
Jul 12DocumentsGoogle DocsGoogle Workspacegws-docs-write
append text to Google Docs
cli
Jul 12DocumentsGoogle DocsGoogle WorkspaceWritinggws-drive
manage files in Google Drive
cli
Jul 12File StorageGoogle DriveGoogle Workspacegws-drive-upload
upload files to Google Drive
cli
Jul 12File StorageFile UploadsGoogle DriveGoogle Workspacegws-events
subscribe to Google Workspace events
cli
Jul 12AutomationGoogle WorkspaceNotifications