Watch for new Gmail messages and stream them as NDJSON, a format with one JSON record per line. Filter messages by label, adjust retrieval settings, or save each message to a separate JSON file.
Gmail: Watch for new emails and stream them as NDJSON.
Review the instructions the agent will receive before you install.
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
gws gmail +watch
| 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 |
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
No reviews yet. Tell others what you thought.
No login needed. Share how it worked for you, ask a question, or note where it did not run.
No comments yet. Be the first to write one.
Retrieve Google Workspace audit logs, which record account activity, and usage reports through gws. Review activity in applications such as the Admin console and Google Drive, or inspect statistics for the organization, users, and entities.
Manage Google Calendar events and calendars, including creating, updating, and deleting events. View upcoming events across calendars, check availability, and manage the permissions that control who can access a calendar.
View upcoming Google Calendar events across all calendars in one agenda. Check today, tomorrow, this week, or a chosen number of days, with options to filter calendars and change the display time zone.
Create a Google Calendar event with a title and start and end times. You can also choose a calendar, add a location and description, invite attendees, and include a Google Meet link.
Manage Google Chat spaces, the places where conversations happen, and their messages through the gws command-line tool. Create or update spaces, add members, send messages, and upload or download attachments.
Send plain text messages to a specified Google Chat space using the gws command line tool. Use it for team updates and announcements, with guidance on finding space identifiers and confirming messages before sending.