/gmail/v1/users/{userId}/settings/forwardingAddresses

POST

users

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://gmail.googleapis.com//gmail/v1/users//settings/forwardingAddresses' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

{
  "forwardingEmail": "string",
  "verificationStatus": "verificationStatusUnspecified"
}

Request

Path Params

userId

string

required

User's email address. The special value "me" can be used to indicate the authenticated user.

Body Params application/json

Settings for a forwarding address.

forwardingEmail

string

optional

An email address to which messages can be forwarded.

verificationStatus

enum<string>

optional

Indicates whether this address has been verified and is usable for forwarding. Read-only.

Allowed values:

verificationStatusUnspecifiedacceptedpending

Examples

Responses

🟢200Successful response

application/json

Body

Settings for a forwarding address.

forwardingEmail

string

optional

An email address to which messages can be forwarded.

verificationStatus

enum<string>

optional

Indicates whether this address has been verified and is usable for forwarding. Read-only.

Allowed values:

verificationStatusUnspecifiedacceptedpending

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/settings/forwardingAddresses

/gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}