batch
Batch creates custom “from” send-as aliases using a CSV file as input.
Synopsis
Implements the API documented at https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/create
gsm sendAs create batch [flags]
Options
--batchThreads int Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
--delimiter string Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
--displayName int 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.
--displayName_ALL string Same as displayName but value is applied to all lines in the CSV file
--fields int Fields allows partial responses to be retrieved.
See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
--fields_ALL string Same as fields but value is applied to all lines in the CSV file
-h, --help help for batch
--host int The hostname of the SMTP service. Required for SMTP.
--host_ALL string Same as host but value is applied to all lines in the CSV file
--isDefault int 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.
--isDefault_ALL Same as isDefault but value is applied to all lines in the CSV file
--password int The password that will be used for authentication with the SMTP service.
--password_ALL string Same as password but value is applied to all lines in the CSV file
--path string Path of the import file (CSV)
--port int The port of the SMTP service. Required for SMTP.
--port_ALL int Same as port but value is applied to all lines in the CSV file
--replyToAddress int 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.
--replyToAddress_ALL string Same as replyToAddress but value is applied to all lines in the CSV file
--securityMode int 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.
--securityMode_ALL string Same as securityMode but value is applied to all lines in the CSV file
--sendAsEmail int The email address that appears in the "From:" header for mail sent using this alias.
--sendAsEmail_ALL string Same as sendAsEmail but value is applied to all lines in the CSV file
--signature int An optional HTML signature that is included in messages composed with this alias in the Gmail web UI.
--signature_ALL string Same as signature but value is applied to all lines in the CSV file
--skipHeader Whether to skip the first row (header)
--treatAsAlias int 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
--treatAsAlias_ALL Same as treatAsAlias but value is applied to all lines in the CSV file
--userId int The user's email address. The special value me can be used to indicate the authenticated user.
--userId_ALL string Same as userId but value is applied to all lines in the CSV file
--username int The username that will be used for authentication with the SMTP service.
--username_ALL string Same as username but value is applied to all lines in the CSV file
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 create - Creates a custom “from” send-as alias