gog gmail search
Generated from
gog schema --json. Do not edit this page by hand; runmake docs-commands.
Search threads using Gmail query syntax
#Usage
gog gmail (mail,email) search (find,query,ls,list) <query> ... [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) | |
--all--all-pages--allpages | bool | Fetch all pages | |
--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) | |
--fail-empty--non-empty--require-results | bool | Exit with code 3 if no results | |
-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. | |
-j--json--machine | bool | false | Output JSON to stdout (best for scripting) |
--local | bool | Use local timezone (default behavior, useful to override --timezone) | |
--max--limit | int64 | 10 | Max results |
--no-input--non-interactive--noninteractive | bool | Never prompt; fail instead (useful for CI) | |
--oldest | bool | Show first message date instead of last | |
--page--cursor | string | Page token | |
-p--plain--tsv | bool | false | Output stable, parseable text to stdout (TSV; no colors) |
--results-only | bool | In JSON mode, emit only the primary result (drops envelope fields like nextPageToken) | |
--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 | |
-v--verbose | bool | Enable verbose logging | |
--version | kong.VersionFlag | Print version and exit |