Filters
Query Filters in Gmail.
Table Specific Information
Query the available Filters
SELECT
The driver uses the GMail REST API to process search criteria that refer to Id column. The driver processes other filters client-side within the driver.
- Id supports the '=' operator.
For example, the following queries are processed server side:
SELECT * FROM Filters WHERE ID = 123
INSERT
Requires the following OAuth scope:
- https://www.googleapis.com/auth/gmail.settings.basic
Example query:
INSERT INTO Filters (AddLabelIds,[From], Subject) VALUES ('TRASH', '[email protected]', 'some subject')
DELETE
Requires the following OAuth scope:
- https://www.googleapis.com/auth/gmail.settings.basic
Example query:
DELETE FROM Filters WHERE Id = 'ANe1BmiqbQyBsAigc6DLeEnxCXPgVM5JHHwNGB32zpMD6-DlEShqDqGOIjFYq1wW-F0c9tqVqg'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The server assigned ID of the filter. | |
| AddLabelIds | String | False |
List of labels to add to the message. | |
| RemoveLabelIds | String | False |
List of labels to remove from the message. | |
| Forward | String | False |
Email address that the message should be forwarded to. | |
| From | String | False |
The sender's display name or email address. | |
| To | String | False |
The recipient's display name or email address. Includes recipients in the | |
| Subject | String | False |
Case-insensitive phrase found in the message's subject. | |
| Query | String | False |
Only return messages matching the specified query. Supports the same query format as the Gmail search box. | |
| NegatedQuery | String | False |
The primary email address of the user. Writeable on create only. On update, a secondary email is added. | |
| HasAttachment | Boolean | False |
Whether the message has any attachment. | |
| ExcludedChats | Boolean | False |
Whether the response should exclude chats. | |
| Size | Integer | False |
The size of the entire RFC822 message in bytes, including all headers and attachments. | |
| SizeComparison | String | False |
How the message size in bytes should be in relation to the size field. |