CData Python Connector for Gmail

Build 25.0.9454

UpdateAutoForwarding

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.

Stored Procedure Specific Information

This procedure is only available to service account clients that have been delegated domain-wide authority.

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/gmail.settings.sharing

Example Query:

EXEC UpdateAutoForwarding @enabled='true', @EmailAddress='[email protected]', @Disposition='READ'

Input

Name Type Required Description
Enabled Bool True Whether all incoming mail is automatically forwarded to another address.
EmailAddress String True Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
Disposition String True The state that a message should be left in after it has been forwarded.

Result Set Columns

Name Type Description
Success String Whether the operation was successful or not.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454