Method: users.settings.getImap
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/imap
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 ImapSettings.
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 Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Retrieves a user's IMAP settings through an HTTP GET request to a specified URL."],["Requires specifying the user's email address (or \"me\" for the authenticated user) as a path parameter."],["An empty request body is necessary, and a successful response returns an ImapSettings object."],["Authorization is required, utilizing one of the provided OAuth scopes for access control."]]],["The core content describes how to retrieve IMAP settings using a `GET` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/imap`. The `userId` path parameter, either an email or \"me\", specifies the user. The request body must be empty. A successful response will return `ImapSettings`. Access requires one of four OAuth scopes, including `gmail.settings.basic`, `mail.google.com`, `gmail.modify`, or `gmail.readonly`. The URL utilizes gRPC Transcoding syntax.\n"]]
