Method: users.settings.getAutoForwarding

Gets the auto-forwarding setting for the specified account.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/autoForwarding

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

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

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of AutoForwarding.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly

For more information, see the OAuth 2.0 Overview.