updateAutoForwarding
Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
Synopsis
Implements the API documented at https://developers.google.com/gmail/api/reference/rest/v1/users.settings/updateAutoForwarding
gsm gmailSettings updateAutoForwarding [flags]
Options
--autoExpunge string If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP.
Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
--disposition string The state that a message should be left in after it has been forwarded.
[LEAVE_IN_INBOX|ARCHIVE|TRASH|MARK_READ]
LEAVE_IN_INBOX - Leave the message in the INBOX.
ARCHIVE - Archive the message.
TRASH - Move the message to the TRASH.
MARK_READ - Leave the message in the INBOX and mark it as read.
--emailAddress string Email address to which all incoming messages are forwarded.
This email address must be a verified member of the forwarding addresses.
--enabled Whether the setting is enabled
--fields string Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
-h, --help help for updateAutoForwarding
--userId string The user's email address. The special value "me" can be used to indicate the authenticated user. (default "me")
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm gmailSettings - Manage Gmail settings for users (Part of Gmail API)