gmail.users.settings.updateImap
Updates a Gmail user's IMAP settings, including enabling IMAP and configuring auto-expunge, expunge behavior, and folder size limits.
Instructions
Updates IMAP settings. For more information, see Configure POP and IMAP settings with the Gmail API [HTTP PUT] — updates the resource; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ImapSettings object accepting autoExpunge, enabled, expungeBehavior, maxFolderSize; pass it via params or whole via body_file Siblings over the same resource: getAutoForwarding, getImap, getLanguage, getPop, getVacation, updateAutoForwarding, 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. The body is a JSON ImapSettings object. | |
| request_body | No | Request body of type ImapSettings: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| enabled | No | ||
| autoExpunge | No | ||
| maxFolderSize | No | ||
| expungeBehavior | No |