Creates a filter. Note: you can only create a maximum of 1,000 filters.

Scopes

You will need authorization for the https://www.googleapis.com/auth/gmail.settings.basic scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/gmail.settings.basic. You can set the scope for this method like this: gmail1 --scope <scope> users settings-filters-create ...

Required Scalar Argument

  • <user-id> (string)
    • User's email address. The special value "me" can be used to indicate the authenticated user.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Filter:
  action:
    add-label-ids: [string]
    forward: string
    remove-label-ids: [string]
  criteria:
    exclude-chats: boolean
    from: string
    has-attachment: boolean
    negated-query: string
    query: string
    size: integer
    size-comparison: string
    subject: string
    to: string
  id: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .action add-label-ids=diam
    • List of labels to add to the message.
    • Each invocation of this argument appends the given value to the array.
  • forward=est
    • Email address that the message should be forwarded to.

  • remove-label-ids=sit

    • List of labels to remove from the message.
    • Each invocation of this argument appends the given value to the array.

  • ..criteria exclude-chats=false

    • Whether the response should exclude chats.
  • from=eos
    • The sender's display name or email address.
  • has-attachment=true
    • Whether the message has any attachment.
  • negated-query=ea
    • Only return messages not matching the specified query. Supports the same query format as the Gmail search box. For example, &#34;from:someuser@example.com rfc822msgid: is:unread&#34;.
  • query=stet
    • Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, &#34;from:someuser@example.com rfc822msgid: is:unread&#34;.
  • size=82
    • The size of the entire RFC822 message in bytes, including all headers and attachments.
  • size-comparison=eos
    • How the message size in bytes should be in relation to the size field.
  • subject=et
    • Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.

  • to=sea

    • 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.

  • .. id=et

    • The server assigned ID of the filter.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").