Update Auto Forwarding
|
|||||
|
|
||||
Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
This method is only available to service account clients that have been delegated domain-wide authority
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your sensitive mail settings, including who can manage your mail
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
userId Required |
STRING |
User's email address. The special value "me" can be used to indicate the authenticated user |
disposition |
ENUMERATION |
The state that a message should be left in after it has been forwarded |
emailAddress |
STRING |
Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses |
enabled |
BOOLEAN |
Whether all incoming mail is automatically forwarded to another address |
= Parameter name
= Format
|
userId STRING Required User's email address. The special value "me" can be used to indicate the authenticated user |
|
disposition ENUMERATION The state that a message should be left in after it has been forwarded |
|
emailAddress STRING Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses |
|
enabled BOOLEAN Whether all incoming mail is automatically forwarded to another address |
Output
This building block provides 3 output parameters
| Name | Format | Description |
|---|---|---|
disposition |
ENUMERATION |
The state that a message should be left in after it has been forwarded |
emailAddress |
STRING |
Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses |
enabled |
BOOLEAN |
Whether all incoming mail is automatically forwarded to another address |
= Parameter name
= Format
|
disposition ENUMERATION The state that a message should be left in after it has been forwarded |
|
emailAddress STRING Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses |
|
enabled BOOLEAN Whether all incoming mail is automatically forwarded to another address |