patch

Patch the specified send-as alias.

Synopsis

Implements the API documented at https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/patch

gsm sendAs patch [flags]

Options

      --displayName string      A name that appears in the "From:" header for mail sent using this alias.
                                For custom "from" addresses, when this is empty, Gmail will populate the "From:" header with the name that is used for the primary address associated with the account.
                                If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
      --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 patch
      --host string             The hostname of the SMTP service. Required for SMTP.
      --isDefault               Whether this address is selected as the default "From:" address in situations such as composing a new message or sending a vacation auto-reply.
                                Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true.
                                Changing this from false to true for an address will result in this field becoming false for the other previous default address.
      --password string         The password that will be used for authentication with the SMTP service.
      --port int                The port of the SMTP service. Required for SMTP.
      --replyToAddress string   An optional email address that is included in a "Reply-To:" header for mail sent using this alias.
                                If this is empty, Gmail will not generate a "Reply-To:" header.
      --securityMode string     The protocol that will be used to secure communication with the SMTP service. Required for SMTP.
                                [NONE|SSL|STARTTLS]
                                NONE      - Communication with the remote SMTP service is unsecured. Requires port 25.
                                SSL       - Communication with the remote SMTP service is secured using SSL.
                                STARTTLS  - Communication with the remote SMTP service is secured using STARTTLS. (default "NONE")
      --sendAsEmail string      The email address that appears in the "From:" header for mail sent using this alias.
      --signature string        An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
      --treatAsAlias            Whether Gmail should treat this address as an alias for the user's primary email address.
                                This setting only applies to custom "from" aliases. See https://support.google.com/a/answer/1710338
      --userId string           The user's email address. The special value me can be used to indicate the authenticated user. (default "me")
      --username string         The username that will be used for authentication with the SMTP service.

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 sendAs - Manage send-as settings for users (Part of Gmail API)
• gsm sendAs patch batch - Batch patches custom “from” send-as aliases using a CSV file as input.