batch

Batch creates filters using a CSV file as input.

Synopsis

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

gsm filters create batch [flags]

Options

      --addLabelIds int              A list of IDs of labels to add to this message. Can be used multiple times.
      --addLabelIds_ALL strings      Same as addLabelIds but value is applied to all lines in the CSV file
      --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 ';'
      --excludeChats int             Whether the response should exclude chats.
      --excludeChats_ALL             Same as excludeChats 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
      --forward int                  Email address that the message should be forwarded to.
      --forward_ALL string           Same as forward but value is applied to all lines in the CSV file
      --from int                     The sender's display name or email address.
      --from_ALL string              Same as from but value is applied to all lines in the CSV file
      --hasAttachment int            Whether the message has any attachment.
      --hasAttachment_ALL            Same as hasAttachment but value is applied to all lines in the CSV file
  -h, --help                         help for batch
      --negatedQuery int             Only return messages not matching the specified query.
                                     Supports the same query format as the Gmail search box.
                                     For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
      --negatedQuery_ALL string      Same as negatedQuery but value is applied to all lines in the CSV file
      --path string                  Path of the import file (CSV)
      --query int                    Only return messages matching the specified query.
                                     Supports the same query format as the Gmail search box.
                                     For example, "from:someuser@example.com rfc822msgid:<somemsgid@example.com> is:unread".
      --query_ALL string             Same as query but value is applied to all lines in the CSV file
      --removeLabelIds int           A list of IDs of labels to remove from this message. Can be used multiple times.
      --removeLabelIds_ALL strings   Same as removeLabelIds but value is applied to all lines in the CSV file
      --size int                     The size of the entire RFC822 message in bytes, including all headers and attachments.
      --sizeComparison int           How the message size in bytes should be in relation to the size field.
                                     "[SMALLER|LARGER]
                                     SMALLER  - Find messages smaller than the given size.
                                     LARGER   - Find messages larger than the given size.
      --sizeComparison_ALL string    Same as sizeComparison but value is applied to all lines in the CSV file
      --size_ALL int                 Same as size but value is applied to all lines in the CSV file
      --skipHeader                   Whether to skip the first row (header)
      --subject int                  Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
      --subject_ALL string           Same as subject but value is applied to all lines in the CSV file
      --to int                       The recipient's display name or email address. Includes recipients in the "to", "cc", and "bcc" header fields.
                                     You can use simply the local part of the email address
                                     For example, "example" and "example@" both match "example@gmail.com".
                                     This field is case-insensitive.
      --to_ALL string                Same as to 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

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 filters create - Creates a filter.