AutoForwarding
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 2024-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Auto-forwarding settings allow you to automatically forward all incoming mail to a specified, verified email address."],["You can choose whether to leave the original email in your inbox, archive it, move it to trash, or mark it as read after forwarding."],["The settings are controlled by three fields: `enabled` (to turn on/off), `emailAddress` (the forwarding destination), and `disposition` (how the original email is handled)."]]],["The provided content outlines the auto-forwarding settings for an email account. Key actions include enabling/disabling forwarding via a boolean, specifying the `emailAddress` to forward messages to, and determining the message's `disposition` after forwarding. The `disposition` can be one of `dispositionUnspecified`, `leaveInInbox`, `archive`, `trash`, or `markRead`, defining how the forwarded message is handled in the original mailbox. The forwarding address needs verification. The format for these settings is represented in JSON.\n"]]