Method: users.settings.forwardingAddresses.create
Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted.
This method is only available to service account clients that have been delegated domain-wide authority.
HTTP request
POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/forwardingAddresses
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 contains an instance of ForwardingAddress.
Response body
If successful, the response body contains a newly created instance of ForwardingAddress.
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."],[[["Creates a forwarding address for a Gmail user, requiring domain-wide delegated authority for service accounts."],["If ownership verification is needed, a verification message is sent, setting the status to `pending`; otherwise, the status is set to `accepted`."],["Uses the `POST` method and provides details on the request body, response body, path parameters, and required authorization scope."],["This feature utilizes the `https://www.googleapis.com/auth/gmail.settings.sharing` OAuth scope for access and management of forwarding addresses."]]],["A forwarding address is created using a `POST` request to the specified URL, including the user's email in the `userId` path parameter. The request body must contain a `ForwardingAddress` instance. Ownership verification might be initiated, setting the status to `pending`. The operation is limited to service accounts with domain-wide authority, requiring the `gmail.settings.sharing` OAuth scope. Successful creation returns a new `ForwardingAddress` instance in the response body.\n"]]
