TDV Adapter for Gmail

Build 22.0.8462

INBOX

Query SENT Messages in Gmail.

Table Specific Information

Query the available INBOX

Select

The driver uses the GMail REST API to process search criteria that refer to Id, Subject, From, To, Date, ThreadId, IncludeSpamTrash, MessageFormat, LabelsFilter, SearchQuery columns. The driver processes other filters client-side within the driver.

  • Id supports the '=' operator.
  • Subject supports the '=' operator.
  • From supports the '=' operator.
  • To supports the '=' operator.
  • Date supports the '>,>=,<,<=,=' operators.
  • ThreadId supports the '=' operator.
  • IncludeSpamTrash supports the '=' operator.
  • MessageFormat supports the '=' operator.
  • LabelsFilter supports the '=' operator. Set this to a comma-separated list of labels that the email should be part of (apart from INBOX). The emails that are returned can also be part of other labels not specified on the filter.
  • SearchQuery supports the '=' operator. Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria.

For example, the following queries are processed server side:

SELECT * FROM INBOX WHERE Id = '123'
SELECT * FROM INBOX WHERE Subject = '123'
SELECT * FROM INBOX WHERE [From] = 'test@gmail.com'
SELECT * FROM INBOX WHERE [To] = 'test@gmail.com'
SELECT * FROM INBOX WHERE [Date] >= '12/12/12 12:12:12'
SELECT * FROM INBOX WHERE [ThreadId] = '123'
SELECT * FROM INBOX WHERE [IncludeSpamTrash] = 'true'
SELECT * FROM INBOX WHERE [MessageFormat] = 'raw'
SELECT * FROM INBOX WHERE [LabelsFilter] = 'IMPORTANT,STARRED'
SELECT * FROM INBOX WHERE [SearchQuery] = 'from:no-reply@gmail.com'

Columns

Name Type References Description
Id [KEY] String The identifier of the mail message.
Subject String The subject of the current message.
From String The sender email address of the current message.
To String The email address of the recipient.
CC String CCed recipient.
BCC String BCCed recipient.
Content String The content of the email.
Date Datetime The date and time the current message was sent.
Size Long The size in bytes of the current message.
Labels String A comma separated list of labels that the email is part of.
AttachmentIds String A comma-separated list of the attachment ids.
AttachmentPath String A comma-separated list of the attachments content. Used in INSERT to set the local path of the file to attach.
Snippet String A snippet of the message.
ThreadId String The thread ID of the email.
HistoryId String The history id of the email.
Headers String A list of headers of the email.
RawMessage String The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw.

Pseudo-Columns

Pseudo-column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
IncludeSpamTrash String Include messages from SPAM and TRASH in the results. (Default: false)
MessageFormat String The format to return the message in: minimal, full, raw, or metadata. (Default: full)
LabelsFilter String Set this to a comma-separated list of labels that the email should be part of.
SearchQuery String Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462