This page provides a guide to Establishing a Connection to Gmail in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Gmail

Establishing a Connection shows how to authenticate to Gmail and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Gmail through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Gmail by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Gmail

The Cloud supports connecting to Gmail using the modern REST API and the IMAP protocol. Control how to connect by using AuthScheme. The REST API is the default.

Authenticating to Gmail

Available authentication schemes include:

• Basic (IMAP only)
• OAuth
• OAuthJWT
• GCP Instance Accounts

Basic (IMAP only)

If you plan to use IMAP, you need to enable it so the driver can communicate with Gmail through the IMAP protocol. IMAP enables all your client devices to work with the same, remote data, instead of individual copies. Follow the steps below to enable access to Gmail over IMAP:

1. Open the Gmail Web interface and click the Settings button (the icon is a gear).
2. On the Forwarding and POP/IMAP tab, select Enable IMAP.
3. Save your changes.

Deprecation notice: As of May 30, 2022, Google no longer supports the use of third-party apps or devices that ask you to sign into your Google Account using only your username and password. There are alternatives that still allow you to use this authentication method, for example, App Passwords. Considering this, the Basic AuthScheme is marked as deprecated. We recommend switching to OAuth because it is a more secure method of authentication.

Set the AuthScheme to Basic and Schema to IMAP for this authentication method. This approach is suitable if you need to access your own data. Set the User and Password properties to valid Gmail user credentials.

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows. In addition, all user account flows require that you create and register a custom OAuth application with Gmail. You can then use the Cloud to acquire and manage the OAuth token values. See Creating a Custom OAuth App for more information about custom applications.

NOTE: CData supports both IMAP and REST schema for OAuth authentication. The only difference is the IMAP requires the User connection property. REST does not.

Web Applications

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.
• User: (IMAP only) Set this to the Gmail user account used to authenticate.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Callback URL you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
2. Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once authenticated, the browser redirects you to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id in your application settings.
• OAuthClientSecret: Set this to the client secret in your application settings.
• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
• OAuthSettingsLocation: Set this to the location where the Cloud saves the OAuth token values, which persist across connections.
• User: (IMAP only) Set this to the Gmail user account used to authenticate.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.
• User: (IMAP only) Set this to the Gmail user account used to authenticate.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

1. Choose one of two options:
   • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
   • Option 2: Install the Cloud on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
2. Then configure the Cloud to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

1. Create the Authorization URL by setting the following properties:
   • InitiateOAuth: Set to OFF.
   • OAuthClientId: Set to the client Id assigned when you registered your application.
   • OAuthClientSecret: Set to the client secret assigned when you registered your application.
   • User: (IMAP only) Set this to the Gmail user account used to authenticate.
2. Call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
3. Log in and grant permissions to the Cloud. You are then redirected to the callback URL, which contains the verifier code.
4. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

• InitiateOAuth: Set this to REFRESH.
• OAuthVerifier: Set this to the verifier code.
• OAuthClientId: Set this to the Client Id in your custom OAuth application settings.
• OAuthClientSecret: Set this to the Client Secret in the custom OAuth application settings.
• OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.
• User: (IMAP only) Set this to the Gmail user account used to authenticate.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Cloud to enable the automatic refreshing of the access token.
• User: (IMAP only) Set this to the Gmail user account used to authenticate.

GCP Instance Accounts

When running on a GCP virtual machine, the Cloud can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

OAuth custom applications are required for desktop applications, web applications, and headless machines.

Enable the Gmail API

Follow these steps to enable the Gmail API:

1. Navigate to the Google Cloud Console.
2. Select Library from the left-hand navigation menu. This opens the Library page.
3. In the search field, enter "Gmail API" and select Gmail API from the search results.
4. On the Gmail API page, click ENABLE.

Create an OAuth App for User Account Authentication

Follow the procedure below to register an app and obtain the OAuthClientId and OAuthClientSecret.

Desktop Applications

Follow the steps below to obtain the OAuthClientId, OAuthClientSecret.

1. Log into the Google API Console.
2. Click Create Project or select an existing project.
3. In the API Manager, select Credentials > Create Credentials > OAuth Client Id.
4. Select the application type. If you are making a desktop application, select Other.
5. Create a consent screen if there are none available in your selected organization. A caveat: If you are not using a Google Workspace account, you are restricted to creating an External-type Consent Screen, which requires specifying a support email and developer contact email. Additional info is optional.
6. Click Create. The OAuthClientId and OAuthClientSecret are displayed.
7. Select Library > Gmail API > Enable API. >

Create an OAuth App for Service Account Authentication

Follow the steps below to create an OAuth application and create a private key:

1. Log into the Google API Console.
2. Click Create Project or select an existing project.
3. In the API Manager, select Credentials > Create Credentials > Service Account Key. In the Service Account menu, select New Service Account or select an existing service account. In the "Key Type" section, select the P12 key type.
4. Click Create. The key pair is downloaded and the private key's password is displayed.
5. Select Library > Gmail API > Enable API.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Cloud models Gmail entities in relational Tables and Stored Procedures. API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Gmail REST Data Model

Gmail REST Data Model describes the schemas available to connect to Gmail REST accounts. You can use tables to work with live Gmail data. You can use stored procedures provided by CData Cloud to automate working with Gmail data.

Gmail IMAP Data Model

Gmail IMAP Data Model describes the schemas available to connect to Gmail IMAP accounts. You can use tables to work with live Gmail data. You can use stored procedures provided by CData Cloud to automate working with Gmail data.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Tables

Tables describes the available tables. Tables are statically defined to model Labels and Messages.

Labels are also exposed as stand-alone tables, so you can retrieve all messages listed in that label. For example: INBOX, SENT, DRAFT and more.

Views

Views describes the available views. Views are statically defined to model Attachments, Filters, History, and more.

Stored Procedures

Stored Procedures are function-like interfaces to Gmail. Stored procedures allow you to execute operations to Gmail, such as retrieving the OAuth Access Token.

The Cloud models the data in Gmail as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Gmail Tables

Name	Description
Labels	Query Labels in Gmail.
Messages	Query Messages in Gmail.
SENT	Query SENT Messages in Gmail.

Query Labels in Gmail.

Table Specific Information

Query the available Labels

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 Labels WHERE Id = 'abc'

Insert

Insert a simple Label.

INSERT INTO [Labels] (Name) VALUES ('LabelName')

Delete

Delete a label

DELETE FROM [Labels] WHERE Id = 'LabelId'

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The immutable ID of the label.
Name	String	False		The display name of the label.
MessageListVisibility	String	False		The visibility of messages with this label in the message list in the Gmail web interface. Acceptable values: HIDE, SHOW.
LabelListVisibility	String	False		The visibility of the label in the label list in the Gmail web interface. Acceptable values: LabelHide, LabelShow, LabelShowIfUnread.
Type	String	True		The owner type for the label.
MessagesTotal	Long	True		The total number of messages with the label.
ThreadsTotal	Long	True		The total number of threads with the label.
MessagesUnread	Long	True		The number of unread messages with the label.
ThreadsUnread	Long	True		The number of unread threads with the label.

Query Messages in Gmail.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the message. Automatically assigned when the mail is created.
Subject	String	False		The subject of the email.
From	String	False		The address where the email is from.
To	String	False		The address where the email is sent to.
Content	String	False		The content of the email.
Date	Datetime	False		The date when the email is sent.
Size	Long	False		The size in bytes of the email.
Labels	String	False		A comma separated list of labels that the email is part of.
AttachmentIds	String	False		A comma separated value of the ids of all attachments in the email.
AttachmentPath	String	False		The path of the attachment.
Snippet	String	False		The snippet of the email.
ThreadId	String	False		The thread id of the email.
HistoryId	String	False		The history id of the email.
Headers	String	False		A list of headers of the email.
RawMessage	String	False		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.

Query SENT Messages in Gmail.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The identifier of the mail message.
Subject	String	False		The subject of the current message.
From	String	False		The sender email address of the current message.
To	String	False		The email address of the recipient.
CC	String	False		CCed recipient.
BCC	String	False		BCCed recipient.
Content	String	False		The content of the email.
Date	Datetime	False		The date and time the current message was sent.
Size	Long	False		The size in bytes of the current message.
Labels	String	False		A comma separated list of labels that the email is part of.
AttachmentIds	String	False		A comma-separated list of the attachment ids.
AttachmentPath	String	False		A comma-separated list of the attachments content. Used in INSERT to set the local path of the file to attach.
Snippet	String	False		A snippet of the message.
ThreadId	String	False		The thread ID of the email.
HistoryId	String	False		The history id of the email.
Headers	String	False		A list of headers of the email.
RawMessage	String	False		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.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Gmail Views

Name	Description
Attachments	Query Attachments in Gmail.
Filters	Query Filters in Gmail.
History	Query History in Gmail.
INBOX	Query SENT Messages in Gmail.
Threads	Query Threads in Gmail.
Users	Query Users in Gmail.

Query Attachments in Gmail.

Table Specific Information

Query the available Attachments

Select

The driver uses the GMail REST API to process search criteria that refer to MessageId, IncludeAttachmentData columns. The driver processes other filters client-side within the driver.

• MessageId supports the '=' operator.
• IncludeAttachmentData supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM Attachments WHERE MessageId = 123
SELECT * FROM Attachments WHERE IncludeAttachmentData = true

Columns

Name	Type	References	Description
Id [KEY]	String		The X-Attachment-Id of the message part header.
MessageId [KEY]	String		The ID of the message containing the attachment.
Filename	String		The name of the attachment file.
Size	Long		The size in bytes of the attachment.
Data	String		The conent of the attachment.

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
IncludeAttachmentData	Boolean		A boolean controling whether to include the attachment data or not. (Default: true)

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

Columns

Name	Type	References	Description
Id [KEY]	String		The server assigned ID of the filter.
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.
From	String		The sender's display name or email address.
To	String		The recipient's display name or email address. Includes recipients in the
Subject	String		Case-insensitive phrase found in the message's subject.
Query	String		Only return messages matching the specified query. Supports the same query format as the Gmail search box.
NegatedQuery	String		The primary email address of the user. Writeable on create only. On update, a secondary email is added.
HasAttachment	Boolean		Whether the message has any attachment.
ExcludedChats	Boolean		Whether the response should exclude chats.
Size	Integer		The size of the entire RFC822 message in bytes, including all headers and attachments.
SizeComparison	String		How the message size in bytes should be in relation to the size field.

Query History in Gmail.

Table Specific Information

Query the available History

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 History WHERE Id > 123

Columns

Name	Type	References	Description
Id [KEY]	Long		The ID of the mailbox's current history record.
MessagesAdded	String		Messages added to the mailbox in this history record.
MessagesDeleted	String		Messages deleted (not Trashed) from the mailbox in this history record.
LabelsAdded	String		Labels added to messages in this history record.
LabelsRemoved	String		Labels removed from messages in this history record.

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] = '[email protected]'
SELECT * FROM INBOX WHERE [To] = '[email protected]'
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:[email protected]'

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.

Query Threads in Gmail.

Columns

Name	Type	References	Description
Id [KEY]	String		The Id of the thread.
HistoryID	String		The Id of the last history record that modified this thread.
Snippet	String		A short part of the message text.

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
LabelsFilter	String		Set this to a comma-separated list of labels that the thread should be part of.
IncludeSpamTrash	String		Include threads from SPAM and TRASH in the results. (Default: false)

Query Users in Gmail.

Columns

Name	Type	References	Description
EmailAddress	String		The email address of the user.
MessagesTotal	String		The total number of messages.
ThreadsTotal	String		The total number of threads.
HistoryId	String		The Id of the history.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Gmail.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Gmail, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Gmail Stored Procedures

Name	Description
SendMailMessage	Sends a message to the specified recipient.

Sends a message to the specified recipient.

Stored Procedure Specific Information

Send an email by using this procedure.

Example to attach only one file:

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @CC = 'email', @Content = 'content', @AttachmentPath = 'C:\\MyDirectory\\MyFile.extension'

Example to attach all files of the first level on a directory:

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @CC = 'email', @Content = 'content', @AttachmentPath = 'C:\\MyDirectory'

Example to attach a combination of multiple files and folders:

INSERT INTO attach#TEMP (AttachmentPath) VALUES ('C:\\MyDirectory\\MyFile.extension')
INSERT INTO attach#TEMP (AttachmentPath) VALUES ('C:\\MyDirectory2')
EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @CC = 'email', @Content = 'content', @AttachmentPath = 'attach#TEMP'

Example to include multiple email recipients:

EXECUTE SendMailMessage @Subject = 'subject', @To = '[email protected],[email protected]', @CC = '[email protected],[email protected]', @Content = 'content'

Input

Name	Type	Required	Description
To	String	True	The email address(es) of the recipient(s).
From	String	False	The email address of the sender.
Subject	String	True	The subject of the mail message.
Content	String	True	The message body.
CC	String	False	CCed recipient(s).
BCC	String	False	BCCed recipient(s).
AttachmentPath	String	False	The attachment file names (with the path if reading from a file) to include in the message.

Result Set Columns

Name	Type	Description
Id	String	The Id for the message as returned by the server.

Stored Procedures

Stored Procedures are function-like interfaces to Gmail. Stored procedures allow you to execute operations to Gmail, such as retrieving the OAuth Access Token.

Note: If you are referencing a gmail default mailbox as an input of a stored procedure make sure to write it in the correct format. Example: [Gmail]/SENT.

The Cloud models the data in Gmail as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Gmail Tables

Name	Description
MailMessages	Create, update, delete, and query Gmail messages.

Create, update, delete, and query Gmail messages.

NOTE: This schema is defined for all tables. Each table name is a mailbox folder on the server.

NOTE:: If the mail contains special characters, the content in the message body is base64 encoded. To retrieve the decoded message, you can either decode the content part of the message body or retrieve it using the GetPart stored procedure.

Table Specific Information

Email address fields contained in this table accept the following formats:

• 'Friendly Name' <[email protected]>
• [email protected]

The default Gmail table names contain a backslash; some also contain spaces. You can use square brackets to escape the table names for the default Gmail folders. For example:

SELECT * FROM [Gmail/All Mail]

Select

The results of a query to this table conform to the defaults below:

• The MessageBody and Headers fields are not returned when listing multiple messages.
• The default number of messages returned is 100. You can change this by setting either LIMIT or MaxItems. If you want to return all mail within a mailbox, specify a value of 0 or -1.

List Messages

To list messages within a specific mailbox, specify the mailbox as the table. The emails are listed from most recent to oldest. Alternatively, you can specify a range of message Ids. The available formats for ranges are below:

• Return only the message with an Id of 10:
  

  SELECT * FROM [Inbox] WHERE Id = 10 

• Return all messages from 10 to 20:
  

  SELECT * FROM [Inbox] WHERE Id BETWEEN 10 AND 20

• Return messages 1, 3, 5
  

  SELECT * FROM [Inbox] WHERE Id IN (1, 3, 5)

Apply Search Criteria

The Cloud offers several possibilities for searching through email. You can use search criteria from the following sources in the WHERE clause of a SELECT query:

• Message fields: To search through mail, specify a value for any of the following columns in the WHERE clause of a SELECT query: To, From, BCC, CC, Subject, MessageBody, Flags, Labels, Size, or Date. Complex statements, nested with parentheses, are supported.

  Filter To, From, BCC, CC, Subject, and MessageBody with the following operators: =, !=, and CONTAINS.

  Flags and Labels support the = and != operators only.

  Filter Date with the following operators: =, <, <=, >, and >=.

  Size supports the < and > operators.

  Note that the CONTAINS function requires full words (For example Test, not Tes), similar to the search bar from the UI. For example, the query below returns all messages from either [email protected] or [email protected] that contain the text 'Test':
  

  SELECT * FROM [Gmail/All Mail] WHERE CONTAINS(MessageBody, "Test") AND ([From] = [email protected] OR [From] = [email protected]) AND Date > '1-1-2012'

• Attachments: In addition to searching by standard columns, you can also filter by attachment file names and by whether an email has an attachment:
  

  SELECT * FROM [Gmail/All Mail] WHERE HasAttachment = 'True' AND Attachments = '.txt'

• Gmail-specific: You can use ThreadId and MsgId for filtering with the = and != operators. You can also use the IN operator for the MsgId columns (the operator is translated internally to multiple statements with the = operator).
• IMAP: As an alternative to the above method of creating search criteria, you can use the SearchCriteria pseudo column to search using any valid IMAP search criteria as specified by RFC.

Insert

Insert statement is used to send mail. The Subject, To, and MessageBody fields are required:

INSERT INTO [Gmail/All Mail] (Subject, MessageBody, To) VALUES ('Test Subject', 'Body Text', '[email protected]')

Update

• To move an email from one mailbox to another, specify the mailbox in the update:
  

  UPDATE [Inbox] SET Mailbox = 'NewMailboxName' WHERE Id = 'MessageId'

  The Id may consist of a single message number, a range of messages specified by two message numbers separated by ':' (e.g., "1:5"), or individual message numbers separated by ',' (e.g., "1:5,7,10").
• When moving an email from one mailbox to another, you may not specify any additional updates.
• To update the flags, specify one or a list of flags in the update:
  

  UPDATE [Inbox] SET Flags = 'Seen' WHERE Id = 'MessageId'

  The standard values of flags as specified by the IMAP RFCs are : 'Answered', 'Flagged', 'Deleted', 'Seen' and 'Draft'.

  The flags specified in query override all the email's current flags.

Delete

When you delete messages from Gmail through IMAP, they are not removed from the server. Instead, Gmail removes the current inbox label and marks the mail as "archived." If you want to permanently delete a message from all folders:

1. Move it to the [Gmail]/Trash.
2. Delete it from the [Gmail]/Trash folder.

The Id field is required:

DELETE FROM [Inbox] WHERE Id = '2'

Additional Notes

• By default, the max number of messages returned is 100. You can change this by setting either LIMIT or MaxItems. If you want to return all emails in a mailbox, you must specify a value of 0 or -1.
• By default, the number of messages returned per page is 25. To change this, you can set the ItemsPerPage pseudo column.
• All message Ids returned are temporary Ids and may change in subsequent requests to the server.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The identifier of the mail message.
Mailbox	String	False		The current mailbox that the item is listed in. Updating this value moves the message to a new mailbox.
Subject	String	False		The subject of the current message.
FullFrom	String	True		The sender name and email address of the current message.
From	String	True		The sender email address of the current message.
FullTo	String	True		A semicolon-separated list of names and email addresses of the recipients.
To	String	False		A semicolon-separated list of the email addresses of the recipients.
FullCC	String	True		A semicolon-separated list of names and email addresses of the CC'd recipients.
CC	String	False		A semicolon-separated list of the email addresses of the CC'd recipients.
FullBCC	String	True		A semicolon-separated list of the names and email addresses of the BCC'd recipients. This field is only applicable for sent mail.
BCC	String	False		A semicolon-separated list of the email addresses of the BCC'd recipients. This field is only applicable for sent mail.
Date	Datetime	True		The date and time the current message was sent.
MessageBody	String	False		The message body. This field can only be set if you specify a single Id in SELECT.
Attachments	String	False		A semicolon-separated list of the attachment file names (with the path specified if reading from a file) included in the message.
AttachmentData	String	False		A semicolon-separated list of the base-64-encoded attachment data included in the message. The file name in the Attachments field must also be specified to use this field.
Size	Int	True		The size in bytes of the current message.
Flags	String	False		The flags set on the current message.
Labels	String	False		The labels of the message, separated by spaces. Gmail treats labels as mailboxes.
ThreadId	String	True		The Gmail thread Id associated with the current message. Several messages may have the same thread Id.
MsgId	String	True		The Gmail message Id associated with the current message. This is a globally unique Id assigned by Google separate from the IMAP Id/UID.
PartIds	String	True		The Id of the message part.
PartFilenames	String	True		The file name of the message part.
PartContentTypes	String	True		The content type of the message part.
PartSizes	String	True		The size of the message part.
Headers	String	True		The message headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true.
AttachmentHeaders	String	True		The attachment headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true.
ContentIds	String	True		The content id headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true.

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
SearchCriteria	String	The search criteria to use for the search operation (i.e., SENTSINCE dd-MMM-yyyy). The IMAP RFCs specifies the exact format of the search criteria. The string consists of one or more search keys and their corresponding values, if any, separated by spaces. For example: 'SINCE 1-Feb-1994 NOT FROM Smith'.
ItemsPerPage	String	The maximum number of items to return per page. The default value is 25.
IsHTML	String	This field sets whether the email has an HTML or plain-text encoding. The default value is TRUE.
Importance	String	The importance of the mail message. The allowed values are UNSPECIFIED, LOW, NORMAL, HIGH. The default value is UNSPECIFIED.
Priority	String	The priority of the mail message. The allowed values are UNSPECIFIED, NONURGENT, URGENT, NORMAL. The default value is UNSPECIFIED.
Sensitivity	String	The sensitivity of the mail message. The allowed values are UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL. The default value is UNSPECIFIED.
DeliveryNotification	String	The email address to send a delivery notification to.
ReadReceipt	String	The email address to send a read receipt to.
ShowLabels	String	This field sets whether to show labels or not. The default value is TRUE.
ShowThreadId	String	This field sets whether to show the thread Id or not. The default value is TRUE.
ShowMsgId	String	This field sets whether to show the unique Gmail Id or not. The default value is TRUE.
UIDMode	String	If this value is set to true, permanent message Ids are used instead of the default temporary Ids. The default value is FALSE.
HasAttachments	String	If this value is set to true, only messages with attachments are listed. If false, all messages are listed.
DownloadAttachments	String	If true, attachments are downloaded with the messages. Available only when specifying a single message Id or the Include Messages connection property is true. By default organizes attachments in subfolders with the message Id as name. The default value is FALSE.
AttachmentFolder	String	The folder that is used for downloading attachments. If this is set, the AttachmentData column does not return any data (that is, returns null) and the attachments are instead be written to disk. NOTE: An error is thrown if filters that cannot be supported server-side are included in the criteria. Please refer to the 'Apply Search Criteria' section for a list of supported filters.
EMLFolder	String	The folder where the complete MIME message, which is saved as an EML file, is downloaded to. If multiple messages are selected, subfolders are created for each message.
Overwrite	String	This field sets whether to overwrite attachments and EML files. The default value is FALSE.
IncludeMessage	String	This field sets whether to include the message content in the response. The default value is FALSE.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Gmail.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Gmail, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Gmail Stored Procedures

Name	Description
AddMailbox	Adds a mailbox to the authorized Gmail account.
DeleteMailbox	Deletes the specified mailbox for the authorized Gmail account.
GetPart	Gets the message part specified by LocalFile or PartId from the message specified by Id on the Gmail server.
MoveEmails	Moves the messages specified by Ids to the mailbox specified by Mailbox .
RenameMailbox	Renames the specified mailbox for the authorized Gmail account.
SendMailMessage	Sends the message specified to the specified recipient.
SetFlags	Adds or Replaces existing flags with the specified flags.
SetLabels	Adds or replaces existing Labels with the specified Labels.

Adds a mailbox to the authorized Gmail account.

Input

Name	Type	Required	Description
Mailbox	String	True	The name of the mailbox to be created.

Result Set Columns

Name	Type	Description
Success	String	Boolean response indicating whether or not the operation was successful.

Deletes the specified mailbox for the authorized Gmail account.

Input

Name	Type	Required	Description
Mailbox	String	True	The name of the mailbox you wish to delete.

Result Set Columns

Name	Type	Description
Success	String	Boolean response indicating whether or not the operation was successful.

Gets the message part specified by LocalFile or PartId from the message specified by Id on the Gmail server.

Input

Name	Type	Required	Description
Id	String	True	The Id of the message that contains the message part. The default value is 1.
LocalFile	String	True	The local file where the content of the message part will be written to.
Mailbox	String	True	The mailbox where the message is currently located. The default value is Inbox.
PartFileName	String	False	The part file name of the part to retrieve. Either the PartId or the PartFileName input must be specified.
PartId	String	False	The part Id of the part to retrieve. Either the PartId or the PartFileName input must be specified.
UIDMode	String	False	If true, permanent message Ids are used instead of the default temporary Ids.
Overwrite	String	False	If true, the file specified in LocalFile input will be overwritten.

Result Set Columns

Name	Type	Description
ContentType	String	The content type.
Size	String	The size of the message part.
FileName	String	The file name of the message part.

Moves the messages specified by Ids to the mailbox specified by Mailbox .

Input

Name	Type	Required	Description
Mailbox	String	True	The mailbox where the message is currently located. The default value is Inbox.
Id	String	True	This inputs indicates the set of messages to operate on. It may consist of a single message id, a range of messages specified by two message numbers separated by ':' (e.g. '1:5'), and/or individual message numbers separated by ',' (e.g. '1:5,7,10'). The default value is 1.
Destination	String	True	The mailbox where the message will be moved. The default value is Inbox.

Result Set Columns

Name	Type	Description
Success	String	Boolean response indicating whether or not the operation was successful.

Renames the specified mailbox for the authorized Gmail account.

Input

Name	Type	Required	Description
Mailbox	String	True	The current name of the mailbox you wish to rename.
NewName	String	True	The new name of the mailbox you wish to rename.

Result Set Columns

Name	Type	Description
Success	String	Boolean response indicating whether or not the operation was successful.

Sends the message specified to the specified recipient.

Note: This procedure makes use of indexed parameters. Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.

Suppose there is an input parameter named Param#. To input multiple instances of an indexed parameter like this, execute:

EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"

In the table below, indexed parameters are denoted with a '#' character at the end of their names.

Input

Name	Type	Required	Description
To	String	True	A semicolon-separated list of names and email addresses of the recipients.
Subject	String	True	The subject of the mail message.
From	String	False	The email address of the sender.
MessageBody	String	True	The message body.
CC	String	False	A semicolon-separated list of names and email addresses of the CCed recipients.
BCC	String	False	A semicolon-separated list of names and email addresses of the BCCed recipients.
Attachment#	String	False	A semicolon-separated list of the attachment file names (with the path if reading from a file) included in the message.
AttachmentData#	String	False	A semicolon-separated list of the base-64-encoded attachment data included in the message. To use this field, you must also specify the file name in Attachments.
IsHTML	String	False	Whether the email is HTML or plain text. The default value is TRUE.
Importance	String	False	The importance of the mail message. The allowed values are UNSPECIFIED, LOW, NORMAL, HIGH. The default value is UNSPECIFIED.
Priority	String	False	The priority of the mail message. The allowed values are UNSPECIFIED, NONURGENT, URGENT, NORMAL. The default value is UNSPECIFIED.
Sensitivity	String	False	The sensitivity of the mail message. The allowed values are UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL. The default value is UNSPECIFIED.
DeliveryNotification	String	False	The email address to send a delivery notification to.
ReadReceipt	String	False	The email address to send a read receipt to.
Charset	String	False	The character set to use in the message. The default value is UTF-8.

Result Set Columns

Name	Type	Description
MessageId	String	The Id for the message as returned by the server.

Adds or Replaces existing flags with the specified flags.

Input

Name	Type	Required	Description
Mailbox	String	True	The Gmail mailbox where the message is located. The default value is Inbox.
Id	String	True	This inputs indicates the set of messages to operate on. It may consist of a single message id, a range of messages specified by two message numbers separated by ':' (e.g. '1:5'), and/or individual message numbers separated by ',' (e.g. '1:5,7,10').
Flags	String	True	Sets the specified flags to the message specified by message set. (e.g., Seen, Deleted, Draft). Flags should be specified as comma separated list(e.g. Seen,Deleted) The default value is Seen.
OperationType	String	False	This indicates weather the specified flags should be added,removed or replace existing flags list. The allowed values are ADD, REPLACE, REMOVE. The default value is REPLACE.

Result Set Columns

Name	Type	Description
Success	String	Boolean response indicating whether or not the operation was successful.

Adds or replaces existing Labels with the specified Labels.

Input

Name	Type	Required	Description
Mailbox	String	True	The Gmail mailbox where the message is located. The default value is Inbox.
Id	String	True	This inputs indicates the set of messages to operate on. It may consist of a single message id, a range of messages specified by two message numbers separated by ':' (e.g. '1:5'), and/or individual message numbers separated by ',' (e.g. '1:5,7,10').
Labels	String	True	The labels to be set to the message specified by the MessageSet property. This input must be a space-delimited list of labels.
OperationType	String	False	This indicates weather the specified labels should be added,removed or replace existing labels list. The allowed values are ADD, REPLACE, REMOVE. The default value is REPLACE.

Result Set Columns

Name	Type	Description
Success	String	Boolean response indicating whether or not the operation was successful.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Gmail:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Inbox table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Inbox' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SendMailMessage stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SendMailMessage' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Inbox table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Inbox' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:gmail:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Gmail.
Schema	Used to specify what Gmail Api to use, either REST (default) or IMAP.
User	The Gmail user account used to authenticate.
Password	The password used to authenticate the user.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	When this is set, the provider will request an access token with this specific scope.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

---

Property	Description
IncludeMessage	Whether to include message body content and attachment data or not.
IsHTML	Determines whether the MesssageBody is HTML or plain-text.
KeepAlive	The IMAP connection should be kept alive when this value is true.
ListMailboxes	Whether to list all mailboxes or just the subscribed IMAP mailboxes.
MaxItems	Maximum number of items to return.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MessageCharset	Specifies the session character set for decoding character data transferred from the IMAP server.
PeekMode	When true PEEK is added to all FETCH commands sent to IMAP. Used to avoid setting the /Seen flag.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
QueryFullDetails	Determines whether to include full details of messages.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UIDMode	If true, permanent message Ids are used instead of the default temporary Ids.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Gmail.
Schema	Used to specify what Gmail Api to use, either REST (default) or IMAP.
User	The Gmail user account used to authenticate.
Password	The password used to authenticate the user.

The type of authentication to use when connecting to Gmail.

Data Type

string

Default Value

"Auto"

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set this to perform OAuth authentication.
• Basic: Set this to use BASIC user / password authentication (deprecated).
• OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
• GCPInstanceAccount: Set this to get Access Token from Google Cloud Platform instance.

Used to specify what Gmail Api to use, either REST (default) or IMAP.

Data Type

string

Default Value

"REST"

Remarks

Used to specify what Gmail Api to use, either REST (default) or IMAP. Note that Basic authentication is supported only in the IMAP Schema.

The Gmail user account used to authenticate.

Data Type

string

Default Value

""

Remarks

Together with Password, this field is used to authenticate against the Gmail server.

The password used to authenticate the user.

Data Type

string

Default Value

""

Remarks

The User and Password are together used to authenticate with the server.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	When this is set, the provider will request an access token with this specific scope.

The client Id assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

When this is set, the provider will request an access token with this specific scope.

Data Type

string

Default Value

""

Remarks

Specify scope to obtain the initial access and refresh token.

Set this property to retrieve a scoped token with specific privileges.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.

The JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The type of key store containing the JWT Certificate.

Possible Values

SSHPUBLIC_KEY_BLOB, PFXBLOB, XMLBLOB, JKSBLOB, GOOGLEJSONBLOB, PEMKEY_BLOB, PUBLIC_KEY_BLOB

Data Type

string

Default Value

"GOOGLEJSONBLOB"

Remarks

This property can take one of the following values:

USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
GOOGLEJSON	The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service.
GOOGLEJSONBLOB	The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service.

The password for the OAuth JWT certificate.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.

The subject of the OAuth JWT certificate.

Data Type

string

Default Value

"*"

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
IncludeMessage	Whether to include message body content and attachment data or not.
IsHTML	Determines whether the MesssageBody is HTML or plain-text.
KeepAlive	The IMAP connection should be kept alive when this value is true.
ListMailboxes	Whether to list all mailboxes or just the subscribed IMAP mailboxes.
MaxItems	Maximum number of items to return.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MessageCharset	Specifies the session character set for decoding character data transferred from the IMAP server.
PeekMode	When true PEEK is added to all FETCH commands sent to IMAP. Used to avoid setting the /Seen flag.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
QueryFullDetails	Determines whether to include full details of messages.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UIDMode	If true, permanent message Ids are used instead of the default temporary Ids.

Whether to include message body content and attachment data or not.

Data Type

bool

Default Value

false

Remarks

Whether to include message body content and attachment data or not.

Determines whether the MesssageBody is HTML or plain-text.

Data Type

bool

Default Value

true

Remarks

Determines whether the MesssageBody is HTML or plain-text.

The IMAP connection should be kept alive when this value is true.

Data Type

bool

Default Value

true

Remarks

The Cloud uses the KeepAlive setting to decide if the IMAP connection should be kept alive. It is preferable to keep a connection alive if more than one query is to be made against the mail server.

Whether to list all mailboxes or just the subscribed IMAP mailboxes.

Possible Values

All, Subscribed

Data Type

string

Default Value

"All"

Remarks

Whether to list all mailboxes or just the subscribed IMAP mailboxes.

• All
• Subscribed

Maximum number of items to return.

Data Type

string

Default Value

"100"

Remarks

Maximum number of items to return.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Specifies the session character set for decoding character data transferred from the IMAP server.

Data Type

string

Default Value

"UTF-8"

Remarks

Specifies the session character set for decoding character data transferred from the IMAP server. The default value is UTF-8. Set it to 'None' to leave the charset unspecified. This can resolve some timeout errors that can be caused by an incorrect charset configuration.

When true PEEK is added to all FETCH commands sent to IMAP. Used to avoid setting the /Seen flag.

Data Type

bool

Default Value

false

Remarks

When true PEEK is added to all FETCH commands sent to IMAP. Used to avoid setting the /Seen flag.

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Determines whether to include full details of messages.

Data Type

bool

Default Value

true

Remarks

Determines whether to include full details of messages. Available only for REST schema.

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.

If true, permanent message Ids are used instead of the default temporary Ids.

Data Type

bool

Default Value

false

Remarks

The default value for UIDMode is false.