Method: users.settings.getPop
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/pop
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 PopSettings.
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 POP settings using their email address."],["Requires an empty request body and returns PopSettings upon success."],["Utilizes gRPC Transcoding for its URL structure and needs specific OAuth scopes for authorization."],["Allows identifying the authenticated user with the \"me\" value in the userId path parameter."]]],["This document details how to retrieve POP settings via a `GET` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/pop`. The `userId` path parameter, representing a user's email (or \"me\"), is required. The request body must be empty. A successful response contains an instance of `PopSettings`. Authorization requires one of four listed OAuth scopes. The `Try it!` section is available for experimentation. It also mentions gRPC Transcoding.\n"]]
