You can control POP access with the accessWindow property. The property not
only determines whether or not POP is enabled, but also which messages may be
retrieved.
Value
Effect
disabled
No POP access
allMail
All messages are available
fromNowOn
Only new messages are available
Message disposition
You can configure the disposition of messages retrieved via POP with
the disposition property.
Value
Effect
archive
Move messages out of the inbox
leaveInInbox
Do nothing, leave messages unread in the inbox
markRead
Mark the messages as read
trash
Moves the message to the trash
IMAP
Enabling and disabling access
You can control IMAP access by setting the enabled property to true
or false, to enable or disable access respectively.
Message Disposition
To set the disposition for deleted messages, use the expungeBehavior property.
Value
Effect
archive
Move messages out of the inbox
deleteForever
Permanently delete the message
trash
Moves the message to the trash
Additionally, if the autoExpunge property is set to true these actions
are performed immediately when the message is deleted via IMAP. Otherwise
messages are left until explicitly requested from the IMAP client.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Managing POP and IMAP\n\nYou can use [Settings](/workspace/gmail/api/reference/rest/v1/users.settings) to configure\nthe behavior of Gmail when accessed via the POP and IMAP protocols.\n\nFor information on how to\n[getPop](/workspace/gmail/api/reference/rest/v1/users.settings/getPop),\n[updatePop](/workspace/gmail/api/reference/rest/v1/users.settings/updatePop),\n[getImap](/workspace/gmail/api/reference/rest/v1/users.settings/getImap),\nor [updateImap](/workspace/gmail/api/reference/rest/v1/users.settings/updateImap), see\nthe [Settings reference](/workspace/gmail/api/reference/rest/v1/users.settings).\n\nPOP\n---\n\n### Enabling and disabling access\n\nYou can control POP access with the `accessWindow` property. The property not\nonly determines whether or not POP is enabled, but also which messages may be\nretrieved.\n\n| Value | Effect |\n|-------------|---------------------------------|\n| `disabled` | No POP access |\n| `allMail` | All messages are available |\n| `fromNowOn` | Only new messages are available |\n\n### Message disposition\n\nYou can configure the disposition of messages retrieved via POP with\nthe `disposition` property.\n\n| Value | Effect |\n|----------------|------------------------------------------------|\n| `archive` | Move messages out of the inbox |\n| `leaveInInbox` | Do nothing, leave messages unread in the inbox |\n| `markRead` | Mark the messages as read |\n| `trash` | Moves the message to the trash |\n\nIMAP\n----\n\n### Enabling and disabling access\n\nYou can control IMAP access by setting the `enabled` property to `true`\nor `false`, to enable or disable access respectively.\n\n### Message Disposition\n\nTo set the disposition for deleted messages, use the `expungeBehavior` property.\n\n| Value | Effect |\n|-----------------|--------------------------------|\n| `archive` | Move messages out of the inbox |\n| `deleteForever` | Permanently delete the message |\n| `trash` | Moves the message to the trash |\n\nAdditionally, if the `autoExpunge` property is set to `true` these actions\nare performed immediately when the message is deleted via IMAP. Otherwise\nmessages are left until explicitly requested from the IMAP client."]]
