create

Creates a filter.

Synopsis

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

gsm filters create [flags]

Options

      --addLabelIds strings      A list of IDs of labels to add to this message. Can be used multiple times.
      --excludeChats             Whether the response should exclude chats.
      --fields string            Fields allows partial responses to be retrieved.
                                 See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
      --forward string           Email address that the message should be forwarded to.
      --from string              The sender's display name or email address.
      --hasAttachment            Whether the message has any attachment.
  -h, --help                     help for create
      --negatedQuery string      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".
      --query string             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".
      --removeLabelIds strings   A list of IDs of labels to remove from this message. Can be used multiple times.
      --size int                 The size of the entire RFC822 message in bytes, including all headers and attachments.
      --sizeComparison string    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.
      --subject string           Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
      --to string                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.
      --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 filters - Manage users’ Gmail message filters (Part of Gmail API)
• gsm filters create batch - Batch creates filters using a CSV file as input.