gws-gmail-watch

Name: gws-gmail-watch
Author: googleworkspace

30kinstalls1.7kforks

How to install gws-gmail-watch?

googleworkspace/cli/gws-gmail-watch

$npx -y skills add googleworkspace/cli --skill gws-gmail-watch

Installs into the current project.

Summary

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

Files · 1

View on GitHub

SKILL.md

1	# gmail +watch
2
3	> PREREQUISITE: Read `../gws-shared/SKILL.md` for auth, global flags, and security rules. If missing, run `gws generate-skills` to create it.
4
5	Watch for new emails and stream them as NDJSON
6
7	## Usage
8
9	```bash
10	gws gmail +watch
11	```
12
13	## Flags
14
15	\| Flag \| Required \| Default \| Description \|
16	\|------\|----------\|---------\|-------------\|
17	\| `--project` \| — \| — \| GCP project ID for Pub/Sub resources \|
18	\| `--subscription` \| — \| — \| Existing Pub/Sub subscription name (skip setup) \|
19	\| `--topic` \| — \| — \| Existing Pub/Sub topic with Gmail push permission already granted \|
20	\| `--label-ids` \| — \| — \| Comma-separated Gmail label IDs to filter (e.g., INBOX,UNREAD) \|
21	\| `--max-messages` \| — \| 10 \| Max messages per pull batch \|
22	\| `--poll-interval` \| — \| 5 \| Seconds between pulls \|
23	\| `--msg-format` \| — \| full \| Gmail message format: full, metadata, minimal, raw \|
24	\| `--once` \| — \| — \| Pull once and exit \|
25	\| `--cleanup` \| — \| — \| Delete created Pub/Sub resources on exit \|
26	\| `--output-dir` \| — \| — \| Write each message to a separate JSON file in this directory \|
27
28	## Examples
29
30	```bash
31	gws gmail +watch --project my-gcp-project
32	gws gmail +watch --project my-project --label-ids INBOX --once
33	gws gmail +watch --subscription projects/p/subscriptions/my-sub
34	gws gmail +watch --project my-project --cleanup --output-dir ./emails
35	```
36
37	## Tips
38
39	- Gmail watch expires after 7 days — re-run to renew.
40	- Without --cleanup, Pub/Sub resources persist for reconnection.
41	- Press Ctrl-C to stop gracefully.
42
43	## See Also
44
45	- [gws-shared](../gws-shared/SKILL.md) — Global flags and auth
46	- [gws-gmail](../gws-gmail/SKILL.md) — All send, read, and manage email commands

People who liked this also viewed

6 picks

Type