AutoForwarding
Stay organized with collections
Save and categorize content based on your preferences.
Auto-forwarding settings for an account.
| JSON representation |
{
"enabled": boolean,
"emailAddress": string,
"disposition": enum (Disposition)
} |
| Fields |
enabled |
boolean
Whether all incoming mail is automatically forwarded to another address.
|
emailAddress |
string
Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
|
disposition |
enum (Disposition)
The state that a message should be left in after it has been forwarded.
|
Disposition
Specifies what Gmail should do with a message after it has been automatically forwarded.
| Enums |
dispositionUnspecified |
Unspecified disposition. |
leaveInInbox |
Leave the message in the INBOX. |
archive |
Archive the message. |
trash |
Move the message to the TRASH. |
markRead |
Leave the message in the INBOX and mark it as read. |
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 2025-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# AutoForwarding\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [Disposition](#Disposition)\n\nAuto-forwarding settings for an account.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"enabled\": boolean, \"emailAddress\": string, \"disposition\": enum (/workspace/gmail/api/reference/rest/v1/AutoForwarding#Disposition) } ``` |\n\n| Fields ||\n|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `enabled` | `boolean` Whether all incoming mail is automatically forwarded to another address. |\n| `emailAddress` | `string` Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses. |\n| `disposition` | `enum (`[Disposition](/workspace/gmail/api/reference/rest/v1/AutoForwarding#Disposition)`)` The state that a message should be left in after it has been forwarded. |\n\nDisposition\n-----------\n\nSpecifies what Gmail should do with a message after it has been automatically forwarded.\n\n| Enums ||\n|--------------------------|-------------------------------------------------------|\n| `dispositionUnspecified` | Unspecified disposition. |\n| `leaveInInbox` | Leave the message in the `INBOX`. |\n| `archive` | Archive the message. |\n| `trash` | Move the message to the `TRASH`. |\n| `markRead` | Leave the message in the `INBOX` and mark it as read. |"]]
