gmail.users.settings.getImap
Retrieves IMAP settings for a Gmail user, returning the configuration as JSON so you can manage email client access.
Instructions
Gets IMAP settings. For more information, see Configure POP and IMAP settings with the Gmail API [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: getAutoForwarding, getLanguage, getPop, getVacation, updateAutoForwarding, updateImap, updateLanguage, updatePop, updateVacation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] User's email address. The special value "me" can be used to indicate the authenticated user. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enabled | No | ||
| autoExpunge | No | ||
| maxFolderSize | No | ||
| expungeBehavior | No |