Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-137956179.1 KB
users

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. This method is only available to service account clients that have been delegated domain-wide authority.

put/gmail/v1/users/{userId}/settings/autoForwarding

Path parameters

userIdstring required

User's email address. The special value "me" can be used to indicate the authenticated user.

Request body

disposition'dispositionUnspecified' | 'leaveInInbox' | 'archive' | 'trash' | 'markRead'

The state that a message should be left in after it has been forwarded.

enabledboolean

Whether all incoming mail is automatically forwarded to another address.

emailAddressstring

Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.

Response

Successful response