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

PUT

users

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is only available to service account clients that have been delegated domain-wide authority.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://gmail.googleapis.com//gmail/v1/users//settings/autoForwarding' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

{
  "disposition": "dispositionUnspecified",
  "emailAddress": "string",
  "enabled": true
}

Request

Path Params

userId

string

required

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

Body Params application/json

Auto-forwarding settings for an account.

disposition

enum<string>

optional

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

Allowed values:

dispositionUnspecifiedleaveInInboxarchivetrashmarkRead

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.

Examples

Responses

🟢200Successful response

application/json

Body

Auto-forwarding settings for an account.

disposition

enum<string>

optional

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

Allowed values:

dispositionUnspecifiedleaveInInboxarchivetrashmarkRead

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.

Modified at 2023-08-15 05:40:23

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

/gmail/v1/users/{userId}/settings/cse/identities