Google: Gmail users settings schemas
8 Google schemas with complete fields and constraints.
← Gmail users settings operations · All schemas
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | IMAP settings for an account. |
autoExpunge | boolean | Optional | If 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. |
enabled | boolean | Optional | Whether IMAP is enabled for the account. |
expungeBehavior | string | Optional | The 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 |
maxFolderSize | JSON | Optional | |
maxFolderSize (anyOf 1) | integer | Alternative | An 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) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Gets POP 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | POP settings for an account. |
accessWindow | string | Optional | The range of messages which are accessible via POP. Known values: accessWindowUnspecified, disabled, fromNowOn, allMail |
disposition | string | Optional | The action that will be executed on a message after it has been fetched via POP. Known values: dispositionUnspecified, leaveInInbox, archive, trash, markRead |
Gets language settings For more information, see Manage language settings (https: developers google com workspace gmail api guides language-settings) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Language settings for an account. These settings correspond to the "Language settings" feature in the web interface. |
displayLanguage | string | Optional | The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example `en-GB`, `fr` or `ja` for British English, French, or Japanese respectively). The set of languages supported by Gmail evolves over time, so please refer to the "Language" dropdown in the Gmail settings for all available options, as described in the language settings help article. For a table of sample values, see [Manage language settings](https://developers.google.com/workspace/gmail/api/guides/language-settings). Not all Gmail clients can display the same set of languages. In the case that a user's display language is not available for use on a particular client, said client automatically chooses to display in the closest supported variant (or a reasonable default). |
Gets the auto-forwarding setting for the specified account For more information, see Manage email forwarding (https: developers google com workspace gmail api guides forwarding settings) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Auto-forwarding settings for an account. |
disposition | string | Optional | The state that a message should be left in after it has been forwarded. Known values: dispositionUnspecified, leaveInInbox, archive, trash, markRead |
emailAddress | string | Optional | Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. |
enabled | boolean | Optional | Whether all incoming mail is automatically forwarded to another address. |
Gets vacation responder settings For more information, see Manage vacation settings with the Gmail API (https: developers google com workspace gmail api guides vacation settings) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface. |
enableAutoReply | boolean | Optional | Flag that controls whether Gmail automatically replies to messages. |
endTime | string | Optional | An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. Format: int64 |
responseBodyHtml | string | Optional | Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used. |
responseBodyPlainText | string | Optional | Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used. |
responseSubject | string | Optional | Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. |
restrictToContacts | boolean | Optional | Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. |
restrictToDomain | boolean | Optional | Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users. |
startTime | string | Optional | An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. Format: int64 |
Updates 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) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | IMAP settings for an account. |
autoExpunge | boolean | Optional | If 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. |
enabled | boolean | Optional | Whether IMAP is enabled for the account. |
expungeBehavior | string | Optional | The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder. One of: expungeBehaviorUnspecified, archive, trash, deleteForever |
maxFolderSize | integer | Optional | An 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 |
Updates POP 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) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | POP settings for an account. |
accessWindow | string | Optional | The range of messages which are accessible via POP. One of: accessWindowUnspecified, disabled, fromNowOn, allMail |
disposition | string | Optional | The action that will be executed on a message after it has been fetched via POP. One of: dispositionUnspecified, leaveInInbox, archive, trash, markRead |
Updates the auto-forwarding setting for the specified account A verified forwarding address must be specified when auto-forwarding is enabled For more information, see Manage email forwarding (https: developers google com workspace gmail api guides forwarding settings) This method is only available to service account clients that have been delegated domain-wide authority — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Auto-forwarding settings for an account. |
disposition | string | Optional | The state that a message should be left in after it has been forwarded. One of: dispositionUnspecified, leaveInInbox, archive, trash, markRead |
emailAddress | string | Optional | Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. |
enabled | boolean | Optional | Whether all incoming mail is automatically forwarded to another address. |