gog gmail settings watch serve
Generated from
gog schema --json. Do not edit this page by hand; runmake docs-commands.
Run Pub/Sub push handler
#Usage
gog gmail (mail,email) settings watch serve [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 for API commands (gmail/calendar/chat/classroom/drive/docs/slides/contacts/tasks/people/sheets/forms/appscript/ads) | |
--bind | string | 127.0.0.1 | Bind address |
--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 commands; dot paths allowed (restricts CLI) | |
--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 | |
--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) | |
--oidc-audience | string | Expected OIDC audience | |
--oidc-email | string | Expected service account email | |
--path | string | /gmail-pubsub | Push handler path |
-p--plain--tsv | bool | false | Output stable, parseable text to stdout (TSV; no colors) |
--port | int | 8788 | Listen port |
--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. | |
-z--timezone | string | Output timezone (IANA name, e.g. America/New_York, UTC). Default: local | |
--token | string | Shared token for x-gog-token or ?token= | |
-v--verbose | bool | Enable verbose logging | |
--verify-oidc | bool | Verify Pub/Sub OIDC tokens | |
--version | kong.VersionFlag | Print version and exit |