Choose Auth Scopes

Auth scopes express the permissions you request users to authorize for your app.

Gmail scopes

The Gmail API supports the following scopes:

Scope CodeDescription
https://www.googleapis.com/auth/gmail.readonly Read all resources and their metadata—no write operations.
https://www.googleapis.com/auth/gmail.compose Create, read, update, and delete drafts. Send messages and drafts.
https://www.googleapis.com/auth/gmail.send Send messages only. No read or modify privileges on mailbox.
https://www.googleapis.com/auth/gmail.insert Insert and import messages only.
https://www.googleapis.com/auth/gmail.labels Create, read, update, and delete labels only.
https://www.googleapis.com/auth/gmail.modify All read/write operations except immediate, permanent deletion of threads and messages, bypassing Trash.
https://www.googleapis.com/auth/gmail.metadata Read resources metadata including labels, history records, and email message headers, but not the message body or attachments.
https://www.googleapis.com/auth/gmail.settings.basic Manage basic mail settings.
https://www.googleapis.com/auth/gmail.settings.sharing Manage sensitive mail settings, including forwarding rules and aliases.

Note:Operations guarded by this scope are restricted to administrative use only. They are only available to G Suite customers using a service account with domain-wide delegation.
https://mail.google.com/ Full access to the account, including permanent deletion of threads and messages. This scope should only be requested if your application needs to immediately and permanently delete threads and messages, bypassing Trash; all other actions can be performed with less permissive scopes.

If your app requires access to any other Google APIs, you can add those scopes as well. For more information about Google API scopes, see Using OAuth 2.0 to Access Google APIs.

What scope or scopes does my app need?

As a general rule, choose the most restrictive scope possible, and avoid requesting scopes that your app does not actually need. Users more readily grant access to limited, clearly described scopes.

Send feedback about...