Skip to content

Google: Gets IMAP settings For more information, see Configure POP and IMAP settings with the Gmail API (https: developers google com workspace gmail api guides pop imap settings) — response body

Gets IMAP settings. For more information, see [Configure POP and IMAP settings with the Gmail API](https://developers.google.com/workspace/gmail/api/guides/pop_imap_settings).: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Gets IMAP settings For more information, see Configure POP and IMAP settings with the Gmail API (https: developers google com workspace gmail api guides pop imap settings) — response body

FieldTypePresenceDescription and constraints
$objectRootIMAP settings for an account.
autoExpungebooleanOptionalIf this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
enabledbooleanOptionalWhether IMAP is enabled for the account.
expungeBehaviorstringOptionalThe action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
Known values: expungeBehaviorUnspecified, archive, trash, deleteForever
maxFolderSizeJSONOptional
maxFolderSize (anyOf 1)integerAlternativeAn optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.
Format: int32
maxFolderSize (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.