Stay organized with collections Save and categorize content based on your preferences.
Resource: FilterResource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.
JSON representation{
"id": string,
"criteria": {
object (Criteria)
},
"action": {
object (Action)
}
} Fields id
string
The server assigned ID of the filter.
criteria
object (Criteria)
Matching criteria for the filter.
action
object (Action)
Action that the filter performs.
CriteriaMessage matching criteria.
JSON representation{
"from": string,
"to": string,
"subject": string,
"query": string,
"negatedQuery": string,
"hasAttachment": boolean,
"excludeChats": boolean,
"size": integer,
"sizeComparison": enum (SizeComparison)
} Fields from
string
The sender's display name or email address.
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.
subject
string
Case-insensitive phrase found in the message's subject. Trailing and leading whitespace are be trimmed and adjacent spaces are collapsed.
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".
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".
hasAttachment
boolean
Whether the message has any attachment.
excludeChats
boolean
Whether the response should exclude chats.
size
integer
The size of the entire RFC822 message in bytes, including all headers and attachments.
sizeComparison
enum (SizeComparison)
How the message size in bytes should be in relation to the size field.
SizeComparisonDetermines how the size field should be compared to the message size.
Enumsunspecified smaller Find messages smaller than the given size. larger Find messages larger than the given size. Action
A set of actions to perform on a message.
JSON representation{
"addLabelIds": [
string
],
"removeLabelIds": [
string
],
"forward": string
} Fields addLabelIds[]
string
List of labels to add to the message.
removeLabelIds[]
string
List of labels to remove from the message.
forward
string
Email address that the message should be forwarded to.
Methodscreate Creates a filter. delete Immediately and permanently deletes the specified filter. get Gets a filter. list Lists the message filters of a Gmail user.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-24 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-24 UTC."],[],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4