REST Resource: users.settings.filters

{
  "id": string,
  "criteria": {
    object (Criteria)
  },
  "action": {
    object (Action)
  }
}

string

The server assigned ID of the filter.

object (Criteria)

Matching criteria for the filter.

object (Action)

Action that the filter performs.

{
  "from": string,
  "to": string,
  "subject": string,
  "query": string,
  "negatedQuery": string,
  "hasAttachment": boolean,
  "excludeChats": boolean,
  "size": integer,
  "sizeComparison": enum (SizeComparison)
}

string

The sender's display name or email address.

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.

string

Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.

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

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

boolean

Whether the message has any attachment.

boolean

Whether the response should exclude chats.

integer

The size of the entire RFC822 message in bytes, including all headers and attachments.

enum (SizeComparison)

How the message size in bytes should be in relation to the size field.

{
  "addLabelIds": [
    string
  ],
  "removeLabelIds": [
    string
  ],
  "forward": string
}

string

List of labels to add to the message.

string

List of labels to remove from the message.

string

Email address that the message should be forwarded to.