gmail.users.settings.forwardingAddresses.create
Creates a Gmail forwarding address for a user, sending a verification message to the recipient when ownership proof is required and marking the resource accepted otherwise.
Instructions
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. For more information, see Manage email forwarding. This method is only available to service account clients that have been delegated domain-wide authority [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON ForwardingAddress object accepting forwardingEmail, verificationStatus; pass it via params or whole via body_file Siblings over the same resource: delete, get, list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| userId | Yes | [URL path segment] User's email address. The special value "me" can be used to indicate the authenticated user. | me |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON ForwardingAddress object. | |
| request_body | No | Request body of type ForwardingAddress: pass it via `params` (merged into the built body) or whole via `body_file`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| forwardingEmail | No | ||
| verificationStatus | No |