gog gmail settings watch pull
Generated from
gog schema --json. Do not edit this page by hand; runmake docs-commands.
Run Pub/Sub pull consumer
#Usage
gog gmail (mail,email) settings watch pull [flags]#Parent
#Flags
| Flag | Type | Default | Help |
|---|---|---|---|
--access-token | string | Use provided access token directly (bypasses stored refresh tokens; token expires in ~1h) | |
-a--account--acct | string | Account email, alias, or auto for authenticated Google API commands | |
--client | string | OAuth client name (selects stored credentials + token bucket) | |
--color | string | auto | Color output: auto|always|never |
--disable-commands | string | Comma-separated list of disabled commands; dot paths allowed | |
-n--dry-run--dryrun--noop--preview | bool | Do not make changes; print intended actions and exit successfully | |
--enable-commands | string | Comma-separated list of enabled command prefixes; dot paths allowed (restricts CLI) | |
--enable-commands-exact | string | Comma-separated list of exact enabled commands; dot paths allowed and parent commands do not enable children | |
--exclude-labels | string | SPAM,TRASH | List of Gmail label IDs to exclude from hook payload (e.g. SPAM,TRASH,Label_123). Set to empty string to disable. |
--fetch-delay | string | 3s | Delay before fetching Gmail history (seconds or duration) |
-y--force--assume-yes--yes | bool | Skip confirmations for destructive commands | |
--gmail-no-send | bool | false | Block Gmail send operations (agent safety) |
-h--help | kong.helpFlag | Show context-sensitive help. | |
--history-types | []string | History types to include (repeatable, comma-separated: messageAdded,messageDeleted,labelAdded,labelRemoved). Default: messageAdded | |
--home | string | Override gogcli config/data/state/cache root (equivalent to GOG_HOME) | |
--hook-token | string | Webhook bearer token | |
--hook-url | string | Webhook URL to forward messages | |
--include-body | bool | Include text/plain body in hook payload | |
-j--json--machine | bool | false | Output JSON to stdout (best for scripting) |
--local | bool | Use local timezone (default behavior, useful to override --timezone) | |
--max-bytes | int | 20000 | Max bytes of body to include |
--no-input--non-interactive--noninteractive | bool | Never prompt; fail instead (useful for CI) | |
-p--plain--tsv | bool | false | Output stable, parseable text to stdout (TSV; no colors) |
--readonly | bool | false | Block mutating API requests at runtime; auth add also requests read-only OAuth scopes |
--results-only | bool | In JSON mode, emit only the primary result (drops envelope fields like nextPageToken) | |
--save-hook | bool | Persist hook settings to watch state | |
--select--pick--project | string | In JSON mode, select comma-separated fields (best-effort; supports dot paths). Desire path: use --fields for most commands. | |
--subscription | string | Pub/Sub pull subscription (projects/.../subscriptions/...) | |
-z--timezone | string | Output timezone (IANA name, e.g. America/NewYork, UTC). Default: GOGTIMEZONE, config, then local | |
-v--verbose | bool | Enable verbose logging | |
--version | kong.VersionFlag | Print version and exit | |
--wrap-untrusted | bool | false | In JSON/raw output, wrap fetched text fields in external untrusted-content markers |