Google: 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)

← Gmail users settings operations · Get started

Operation google.gmail_users_settings_updateimap

Provider route: PUT /gmail/v1/users/{userId}/settings/imap. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["gmailUsersSettings"]["gmailUsersSettingsUpdateImap"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.gmailUsersSettings.gmailUsersSettingsUpdateImap(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.gmail_users_settings.gmail_users_settings_update_imap(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.userId	string	Required within parent	User’s email address. The special value “me” can be used to indicate the authenticated user. Default: me
query	object	Optional	Additional keys: not allowed
query.fields	string	Optional	Selector specifying which fields to include in a partial response.
query.prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
query.quotaUser	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
body	Model	Required within parent	Expand 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

Referenced models: 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

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand 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

Referenced models: 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

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]+)?$

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

Policy, approvals and errors

SDK function policy ID: google.gmail_users_settings_updateimap. Catalog operation: gmail.users.settings.updateImap. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/gmail.settings.basic"]

Official provider source