Home Guides Reference Samples Support

Users.settings: updatePop

Updates POP settings. Try it now.

Request

HTTP request

PUT https://www.googleapis.com/gmail/v1/users/userId/settings/pop

Parameters

Parameter name Value Description
Path parameters
userId string User's email address. The special value "me" can be used to indicate the authenticated user.

Authorization

This request requires authorization with the following scope:

Scope
https://www.googleapis.com/auth/gmail.settings.basic

For more information, see the authentication and authorization page.

Request body

In the request body, supply data with the following structure:

{
  "accessWindow": string,
  "disposition": string
}
Property name Value Description Notes
accessWindow string The range of messages which are accessible via POP.

Acceptable values are:
  • "accessWindowUnspecified": Unspecified range.
  • "allMail": Indicates that all unfetched messages are accessible via POP.
  • "disabled": Indicates that no messages are accessible via POP.
  • "fromNowOn": Indicates that unfetched messages received after some past point in time are accessible via POP.
disposition string The action that will be executed on a message after it has been fetched via POP.

Acceptable values are:
  • "archive": Archive the message.
  • "dispositionUnspecified": Unspecified disposition.
  • "leaveInInbox": Leave the message in the INBOX.
  • "markRead": Leave the message in the INBOX and mark it as read.
  • "trash": Move the message to the TRASH.

Response

If successful, this method returns a response body with the following structure:

{
  "accessWindow": string,
  "disposition": string
}
Property name Value Description Notes
accessWindow string The range of messages which are accessible via POP.

Acceptable values are:
  • "accessWindowUnspecified": Unspecified range.
  • "allMail": Indicates that all unfetched messages are accessible via POP.
  • "disabled": Indicates that no messages are accessible via POP.
  • "fromNowOn": Indicates that unfetched messages received after some past point in time are accessible via POP.
disposition string The action that will be executed on a message after it has been fetched via POP.

Acceptable values are:
  • "archive": Archive the message.
  • "dispositionUnspecified": Unspecified disposition.
  • "leaveInInbox": Leave the message in the INBOX.
  • "markRead": Leave the message in the INBOX and mark it as read.
  • "trash": Move the message to the TRASH.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.