Method: users.settings.forwardingAddresses.delete
Deletes the specified forwarding address and revokes any verification that may have been required.
This method is only available to service account clients that have been delegated domain-wide authority.
HTTP request
DELETE https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
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.
|
forwardingEmail |
string
The forwarding address to be deleted.
|
Request body
The request body must be empty.
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/gmail.settings.sharing
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."],[[["Deletes a specified forwarding address and any associated verification for service account clients with domain-wide authority."],["Requires a `DELETE` request to the Gmail API with the user ID and forwarding email address in the path."],["Request body should be empty, and a successful deletion results in an empty response body."],["Needs authorization with the `https://www.googleapis.com/auth/gmail.settings.sharing` OAuth scope."]]],["This document outlines the process to delete a forwarding address in Gmail using a `DELETE` HTTP request. The request requires a `userId` and `forwardingEmail` in the URL path. The request body must be empty. Successful deletion yields an empty response body. This action is restricted to service accounts with delegated domain-wide authority. It needs `https://www.googleapis.com/auth/gmail.settings.sharing` OAuth scope for authorization. gRPC Transcoding syntax is utilized in the URL.\n"]]
