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.

Domain-Wide Delegation Requirements

To authenticate a service account with Gmail using OAuthJWT, Google requires domain-wide delegation to be properly configured in the Workspace Admin Console. This setup authorizes the service account to impersonate users in the domain, which is a requirement for accessing Gmail data.

• Domain-wide delegation is required: Without this, Gmail returns a "[400] Precondition check failed" error when attempting to connect.
• Only Google Workspace accounts are supported: Personal Gmail accounts (ending in @gmail.com) do not support domain-wide delegation and cannot be used with service accounts for Gmail API access.
• Each connection must impersonate a specific user: Use the OAuthJWTSubject property to specify the Workspace user whose mailbox the service account should access. Only one user can be impersonated per connection.
• Propagation may take time: After configuring delegation, changes may take up to 24 hours to fully take effect across all users.
• Admin access is required: A Google Workspace super administrator must authorize the service account and assign the appropriate OAuth scopes.

See Google Domain-Wide Delegation Guide for more information.

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 creating 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 TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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. The Cloud uses the Gmail API to process supported filters. The Cloud processes other filters client-side within the Cloud.

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
Delegates	Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account
Draft	Query Draft Messages in Gmail.
Filters	Query Filters in Gmail.
ForwardingAddresses	Query or create forwarding addresses.
Labels	Query Labels in Gmail.
MessageLabels	Query Message labels in gmail. A row will be returned for each label.
Messages	Query Messages in Gmail.
SendAs	Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom from address. Send-as aliases correspond to the Send Mail As feature in the web interface.
SendAsAliasSmimeInfo	Query, create or delete s/mime email configurations.
SENT	Query SENT Messages in Gmail.

Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account

Columns

Name	Type	ReadOnly	References	Description
DelegateEmail [KEY]	String	False		The email address of the delegate.
VerificationStatus	String	True		Indicates whether this address has been verified and can act as a delegate for the account. Read-only.

Query Draft Messages in Gmail.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		The Id of the draft.Automatically assigned when the mail is created.
MessageId	String	True		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.
CC	String	False		The primary email address of the user. Writeable on create only. On update, a secondary email is added.
BCC	String	False		The primary email address of the user. Writeable on create only. On update, a secondary email is added.
Content	String	False		The content of the email.
Date	Datetime	False		The date when the email is sent.
Size	Long	True		The size in bytes of the email.
Labels	String	True		A comma separated value of labels that the email is part of.
AttachmentIds	String	True		A comma separated value of the ids of all attachments in the email.
Snippet	String	True		The snippet of the email.
ThreadId	String	True		The thread id of the email.
HistoryId	String	True		The history id of the email.
Headers	String	True		A list of headers of the email.
RawMessage	String	True		The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw.
AttachmentPath	String	False		The path 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
IncludeSpamTrash	Boolean	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)
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 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.

Query or create forwarding addresses.

Columns

Name	Type	ReadOnly	References	Description
ForwardingEmail [KEY]	String	False		An email address to which messages can be forwarded.
VerificationStatus	String	True		Indicates whether this address has been verified and is usable for forwarding.

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')

Update

Update a label.

UPDATE Labels SET Name = 'new name' WHERE Id = 'abc'

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 Message labels in gmail. A row will be returned for each label.

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The Id of the message. Automatically assigned when the mail is created.
LabelId [KEY]	String	False		The thread id of the email.

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.

Settings associated with a send-as alias, which can be either the primary login address associated with the account or a custom from address. Send-as aliases correspond to the Send Mail As feature in the web interface.

Table Specific Information

Query the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases.

Select

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

• SendAsEmail supports the '=' operator.

For example, the following queries are processed server side:

SELECT * FROM SendAs WHERE SendAsEmail = '[email protected]'

INSERT/UPDATE/DELETE operations are restricted.

These operations are only available to service account clients that have been delegated domain-wide authority.

Columns

Name	Type	ReadOnly	References	Description
SendAsEmail [KEY]	String	False		The email address that appears in the From: header for mail sent using this alias. This is read-only for all operations except create.
DisplayName	String	False		A name that appears in the From: header for mail sent using this alias. For custom from addresses, when this is empty, Gmail will populate the From: header with the name that is used for the primary address associated with the account. If the admin has disabled the ability for users to update their name format, requests to update this field for the primary login will silently fail.
ReplyToAddress	String	False		An optional email address that is included in a Reply-To: header for mail sent using this alias. If this is empty, Gmail will not generate a Reply-To: header.
Signature	String	False		An optional HTML signature that is included in messages composed with this alias in the Gmail web UI. This signature is added to new emails only.
IsPrimary	Bool	False		Whether this address is the primary address used to login to the account. Every Gmail account has exactly one primary address, and it cannot be deleted from the collection of send-as aliases. This field is read-only.
IsDefault	Bool	False		Whether this address is selected as the default From: address in situations such as composing a new message or sending a vacation auto-reply. Every Gmail account has exactly one default send-as address, so the only legal value that clients may write to this field is true. Changing this from false to true for an address will result in this field becoming false for the other previous default address.
TreatAsAlias	Bool	False		Whether Gmail should treat this address as an alias for the users primary email address. This setting only applies to custom from aliases.
SmtpMsaHost	String	False		The hostname of the SMTP service. Required.
SmtpMsaPort	Integer	False		The port of the SMTP service. Required.
SmtpMsaUsername	String	False		The username that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
SmtpMsaPassword	String	False		The password that will be used for authentication with the SMTP service. This is a write-only field that can be specified in requests to create or update SendAs settings; it is never populated in responses.
SmtpMsaSecurityMode	String	False		The protocol that will be used to secure communication with the SMTP service. Required.
VerificationStatus	String	False		Indicates whether this address has been verified for use as a send-as alias. Read-only. This setting only applies to custom from aliases.

Query, create or delete s/mime email configurations.

Table Specific Information

Query the available SendAsAliasSmimeInfo.

SELECT

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

The driver uses the GMail REST API to process search criteria that refer to the Id and SendAsEmail columns. The driver processes other filters client-side within the driver.

• Id supports the '=' operator.
• SendAsEmail supports the '=' operator.

For example, the following queries are processed server-side:

SELECT * FROM SendAsAliasSmimeInfo WHERE ID = 123

INSERT

This method is only available to service account clients that have been delegated domain-wide authority.

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.sharing

DELETE

This method is only available to service account clients that have been delegated domain-wide authority.

Requires the following OAuth scopes:

• https://www.googleapis.com/auth/gmail.settings.basic
• https://www.googleapis.com/auth/gmail.settings.sharing

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	False		The immutable ID for the SmimeInfo.
SendAsEmail [KEY]	String	False		he email address that appears in the From header for mail sent using this alias.
IssuerCn	String	False		The S/MIME certificate issuer's common name.
IsDefault	Bool	False		Whether this SmimeInfo is the default one for this user's send-as address.
Expiration	Datetime	False		When the certificate expires
EncryptedKeyPassword	String	False		Encrypted key password, when key is encrypted.
Pem	String	False		PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
Pkcs12	String	False		PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. A base64-encoded string.

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.
AutoForwarding	Query the auto-forwarding setting for the specified account.
History	Query History in Gmail.
INBOX	Query SENT Messages in Gmail.
Language	Query language settings.
Threads	Query Threads in Gmail.
Users	Query Users in Gmail.
Vacation	Query vacation responder settings.

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 the auto-forwarding setting for the specified account.

Table Specific Information

SELECT

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

Example Query:

SELECT * FROM AutoForwarding

UPDATE

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.sharing

INSERT/DELETE

These methods are not available.

Columns

Name	Type	References	Description
Enabled	Bool		Whether all incoming mail is automatically forwarded to another address.
EmailAddress	String		Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
Disposition	String		The state that a message should be left in after it has been forwarded.

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 language settings.

Table Specific Information

SELECT

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

Example Query:

SELECT * FROM Language

UPDATE

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

INSERT/DELETE

These methods are not available.

Columns

Name	Type	References	Description
DisplayLanguage	String		The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).

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.

Query vacation responder settings.

Table Specific Information

SELECT

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

Example Query:

SELECT * FROM Vacation

UPDATE

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

INSERT/DELETE

These methods are not available.

Columns

Name	Type	References	Description
EnableAutoReply	Bool		Flag that controls whether Gmail automatically replies to messages.
ResponseSubject	String		Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
ResponseBodyPlainText	String		Response body in plain text format. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
ResponseBodyHtml	String		Response body in HTML format. Gmail will sanitize the HTML before storing it. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
RestrictToContacts	Bool		Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
RestrictToDomain	Bool		Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
StartTime	Datetime		An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
EndTime	Datetime		An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

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
GetAutoForwarding	Gets the auto-forwarding setting for the specified account.
GetImap	Query IMAP settings.
GetLanguage	Language settings for an account. These settings correspond to the 'Language settings' feature in the web interface.
GetPop	Query POP settings.
GetUserProfile	Gets the current user's Gmail profile.
GetVacations	Gets vacation responder settings.
ImportMessage	Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message.
ReplyToMailMessage	Reply to a mail message.
SendDraft	Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.
SendMailMessage	Sends a message to the specified recipient.
SetDefaultSendAsAliasSmimeConfig	Sets the default S/MIME config for the specified send-as alias.
StartNotifications	Set up or update a push notification watch on the given user mailbox.
StopNotifications	Stop receiving push notifications for the given user mailbox.
TrashMessage	Moves the specified message to the trash.
UntrashMessage	Removes the specified message from the trash.
UpdateAutoForwarding	Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.
UpdateImap	Updates IMAP settings.
UpdateLanguage	Update language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.
UpdateMessageLabels	Update message labels by either adding or removing labels to messages.
UpdatePop	Updates POP settings.
UpdateVacations	Updates vacation responder settings.
VerifySendAs	Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority.

Gets the auto-forwarding setting for the specified account.

Stored Procedure Specific Information

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

Example Query:

EXEC GetAutoForwarding

Result Set Columns

Name	Type	Description
Enabled	Bool	Whether all incoming mail is automatically forwarded to another address.
EmailAddress	String	Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
Disposition	String	The state that a message should be left in after it has been forwarded.

Query IMAP settings.

Stored Procedure Specific Information

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

EXECUTE GetImap

Result Set Columns

Name	Type	Description
Enabled	Bool	Whether IMAP is enabled for the account.
AutoExpunge	Bool	If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
ExpungeBehavior	String	The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
MaxFolderSize	Integer	An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Language settings for an account. These settings correspond to the 'Language settings' feature in the web interface.

Stored Procedure Specific Information

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

EXEC GetLanguage

Result Set Columns

Name	Type	Description
DisplayLanguage	String	The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).

Query POP settings.

Stored Procedure Specific Information

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

EXEC GetPop

Result Set Columns

Name	Type	Description
AccessWindow	String	The range of messages which are accessible via POP.
Disposition	String	The action that will be executed on a message after it has been fetched via POP.

Gets the current user's Gmail profile.

Result Set Columns

Name	Type	Description
EmailAddress	String	The user's email address
MessagesTotal	Integer	The total number of messages in the mailbox.
ThreadsTotal	Integer	The total number of threads in the mailbox.
HistoryId	String	The ID of the mailbox's current history record.

Gets vacation responder settings.

Result Set Columns

Name	Type	Description
EnableAutoReply	Bool	Flag that controls whether Gmail automatically replies to messages.
ResponseSubject	String	Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
ResponseBodyPlainText	String	Response body in plain text format. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
ResponseBodyHtml	String	Response body in HTML format. Gmail will sanitize the HTML before storing it. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
RestrictToContacts	Bool	Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
RestrictToDomain	Bool	Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
StartTime	Datetime	An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
EndTime	Datetime	An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. This method doesn't perform SPF checks, so it might not work for some spam messages, such as those attempting to perform domain spoofing. This method does not send a message.

Input

Name	Type	Required	Description
Subject	String	False	The subject of the mail message.
To	String	False	The email address(es) of the recipient(s).
From	String	False	The email address of the sender.
CC	String	False	CCed recipient(s).
BCC	String	False	BCCed recipient(s).
Content	String	False	The message body.
Deleted	Bool	False	Mark the email as permanently deleted (not TRASH) and only visible in Google Vault to a Vault administrator. Only used for Google Workspace accounts.
NeverMarkSpam	Bool	False	Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.
Attachments	String	False	The attachment content. Either the name of the temp table or the json aggregate.

Result Set Columns

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

Reply to a mail message.

Stored Procedure Specific Information

Reply to an email by using this procedure.

Example on how to include attachments:

By using JSON aggregates

{
    "Attachments": [{"fileName": "filename", "data": "base64Encoded attachment content"}]
}

EXECUTE ReplyToMailMessage  @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "json aggregate"

By using temporary tables:

INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('MyFile.txt', "base64Encoded data")
INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('C:\\MyDirectory\\MyFile.extensio', "")

EXECUTE ReplyToMailMessage  @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "Attachments#TEMP"

Input

Name	Type	Required	Description
MessageId	String	True	The id of the message to reply to. Can be retrieved from the Messages table.
From	String	False	The email address of the sender.
To	String	True	The email address(es) of the recipient(s).
CC	String	False	CCed recipient(s).
BCC	String	False	BCCed recipient(s).
Content	String	False	The message body.
Attachments	String	False	The attachment content. Either the name of the temp table or the json aggregate.

Result Set Columns

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

Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers.

Input

Name	Type	Required	Description
DraftId	String	True	The immutable ID of the draft.

Result Set Columns

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

Sends a message to the specified recipient.

Stored Procedure Specific Information

Send an email by using this procedure.

Example on how to include attachments:

By using JSON aggregates

{
    "Attachments": [{"fileName": "filename", "data": "base64Encoded attachment content"}]
}

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "json aggregate"

By using temporary tables:

INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('MyFile.txt', "base64Encoded data")
INSERT INTO Attachments#TEMP (FileName, Data) VALUES ('C:\\MyDirectory\\MyFile.extensio', "")

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @Attachments = "Attachments#TEMP"

The following scenarios still wok but are deprecated and will be removed in future releases.

Example to attach only one file:

EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @From = 'sender_email', @CC = 'email', @BCC = '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', @From = 'sender_email', @CC = 'email', @BCC = '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', @From = 'sender_email', @CC = 'email', @BCC = 'email', @Content = 'content', @AttachmentPath = 'attach#TEMP'

Example to include multiple email recipients:

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

Input

Name	Type	Required	Description
Subject	String	True	The subject of the mail message.
To	String	True	The email address(es) of the recipient(s).
From	String	False	The email address of the sender.
CC	String	False	CCed recipient(s).
BCC	String	False	BCCed recipient(s).
Content	String	True	The message body.
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.

Sets the default S/MIME config for the specified send-as alias.

Stored Procedure Specific Information

Requires the following OAuth scopes:

• https://www.googleapis.com/auth/gmail.settings.basic
• https://www.googleapis.com/auth/gmail.settings.sharing

EXECUTE GetImap

Input

Name	Type	Required	Description
Id	String	True	The immutable ID for the SmimeInfo.
SendAsEmail	String	True	The email address that appears in the From header for mail sent using this alias.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Set up or update a push notification watch on the given user mailbox.

Input

Name	Type	Required	Description
LabelIds	String	False	A comma separated list of labelIds to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated.
LabelFilterBehavior	String	False	Filtering behavior of labelIds list specified.
TopicName	String	True	A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail publish permission on it. For example: projects/my-project-identifier/topics/my-topic-name (using the Cloud Pub/Sub v1 topic naming format)

Result Set Columns

Name	Type	Description
HistoryId	String	The ID of the mailbox's current history record.
Expiration	String	When Gmail will stop sending notifications for mailbox updates (epoch millis). Call the procedure again before this time to renew the watch.

Stop receiving push notifications for the given user mailbox.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Moves the specified message to the trash.

Input

Name	Type	Required	Description
MessageId	String	True	The ID of the message to Trash.

Result Set Columns

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

Removes the specified message from the trash.

Input

Name	Type	Required	Description
MessageId	String	True	The ID of the message to remove from Trash.

Result Set Columns

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

Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled.

Stored Procedure Specific Information

This procedure is only available to service account clients that have been delegated domain-wide authority.

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.sharing

Example Query:

EXEC UpdateAutoForwarding @enabled='true', @EmailAddress='[email protected]', @Disposition='READ'

Input

Name	Type	Required	Description
Enabled	Bool	True	Whether all incoming mail is automatically forwarded to another address.
EmailAddress	String	True	Email address to which all incoming messages are forwarded. This email address must be a verified member of the forwarding addresses.
Disposition	String	True	The state that a message should be left in after it has been forwarded.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Updates IMAP settings.

Stored Procedure Specific Information

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

Example Query:

EXECUTE UpdateImap @enabled='false', @AutoExpunge='false', @expungeBehavior='archive', @maxFolderSize='0'

Input

Name	Type	Required	Description
Enabled	Bool	True	Whether IMAP is enabled for the account.
AutoExpunge	Bool	False	If this value is true, Gmail will immediately expunge a message when it is marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the client before expunging messages marked as deleted.
ExpungeBehavior	String	False	The action that will be executed on a message when it is marked as deleted and expunged from the last visible IMAP folder.
MaxFolderSize	Integer	False	An optional limit on the number of messages that an IMAP folder may contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted to mean that there is no limit.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Update language settings. If successful, the return object contains the displayLanguage that was saved for the user, which may differ from the value passed into the request. This is because the requested displayLanguage may not be directly supported by Gmail but have a close variant that is, and so the variant may be chosen and saved instead.

Stored Procedure Specific Information

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

Example query:

EXECUTE UpdateLanguage @displaylanguage='en'

Input

Name	Type	Required	Description
DisplayLanguage	String	True	The language to display Gmail in, formatted as an RFC 3066 Language Tag (for example en-GB, fr or ja for British English, French, or Japanese respectively).

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Update message labels by either adding or removing labels to messages.

Input

Name	Type	Required	Description
MessageIds	String	True	The IDs of the messages to modify. There is a limit of 1000 ids per request.
LabelsToAdd	String	False	A list of IDs of labels to add to this message. Limited to only 100 labels.
LabelsToRemove	String	False	A list IDs of labels to remove from this message. Limited to only 100 labels.

Result Set Columns

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

Updates POP settings.

Stored Procedure Specific Information

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.basic

Example Query:

EXECUTE UpdatePop @accessWindow='allMail', @disposition='leaveInInbox'

Input

Name	Type	Required	Description
AccessWindow	String	True	The range of messages which are accessible via POP.
Disposition	String	True	The action that will be executed on a message after it has been fetched via POP.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Updates vacation responder settings.

Input

Name	Type	Required	Description
EnableAutoReply	Bool	False	Flag that controls whether Gmail automatically replies to messages.
ResponseSubject	String	False	Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
ResponseBodyPlainText	String	False	Response body in plain text format. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
ResponseBodyHtml	String	False	Response body in HTML format. Gmail will sanitize the HTML before storing it. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
RestrictToContacts	Bool	False	Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
RestrictToDomain	Bool	False	Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
StartTime	Datetime	False	An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
EndTime	Datetime	False	An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.

Result Set Columns

Name	Type	Description
Success	String	Whether the operation was successful or not.

Sends a verification email to the specified send-as alias address. The verification status must be pending. This method is only available to service account clients that have been delegated domain-wide authority.

Stored Procedure Specific Information

This procedure is only available to service account clients that have been delegated domain-wide authority.

Requires the following OAuth scope:

• https://www.googleapis.com/auth/gmail.settings.sharing

Example Query:

EXEC VerifySendAs @SendAsEmail = '[email protected]'

Input

Name	Type	Required	Description
SendAsEmail	String	True	The send-as alias to be verified.

Result Set Columns

Name	Type	Description
Success	String	Whether this operation was successful or not.

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.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SendMailMessage' AND IncludeResultColumns='True'

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.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric 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.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Gmail procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

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.

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.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
DelegatedServiceAccounts	Specifies a space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	Specifies a service account email to make a delegated request.
Scope	When this is set, the provider will request an access token with this specific scope.

JWT OAuth

---

Property	Description
OAuthJWTCert	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

SSL

---

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

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
AWSWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via AWS.
AzureWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via Azure.
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	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
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	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QueryFullDetails	Determines whether to include full details of messages.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UIDMode	If true, permanent message Ids are used instead of the default temporary Ids.
WorkloadPoolId	The ID of your Workload Identity Federation pool.
WorkloadProjectId	The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderId	The ID of your Workload Identity Federation pool provider.

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	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.

The type of authentication to use when connecting to Gmail.

Possible Values

OAuth, OAuthJWT, AWSWorkloadIdentity, AzureWorkloadIdentity, Basic

Data Type

string

Default Value

"OAuth"

Remarks

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

Possible Values

REST

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.

Specifies the authenticating user's user ID.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

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

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
DelegatedServiceAccounts	Specifies a space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	Specifies a service account email to make a delegated request.
Scope	When this is set, the provider will request an access token with this specific scope.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Specifies a space-delimited list of service account emails for delegated requests.

Data Type

string

Default Value

""

Remarks

The service account emails must be specified in a space-delimited list.

Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain.

The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the requesting service account. The requesting service account is the one specified in the RequestingServiceAccount property.

Note that for delegated requests, the requesting service account must have the permission iam.serviceAccounts.getAccessToken, which can also be granted through the serviceAccountTokenCreator role.

Specifies a service account email to make a delegated request.

Data Type

string

Default Value

""

Remarks

The service account email of the account for which the credentials are requested in a delegated request. With the list of delegated service accounts in DelegatedServiceAccounts, this property is used to make a delegated request.

You must have the IAM permission iam.serviceAccounts.getAccessToken on this service account.

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

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

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	Supplies the name of the client certificate's JWT Certificate store.
OAuthJWTCertType	Identifies the type of key store containing the JWT Certificate.
OAuthJWTCertPassword	Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

Supplies the name of the client certificate's JWT Certificate store.

Data Type

string

Default Value

""

Remarks

The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Cloud initiates a search for a certificate. For further information, see OAuthJWTCertSubject.

Designations of certificate stores are platform-dependent.

Notes

• The most common User and Machine certificate stores in Windows include:
  • 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).

Identifies the type of key store containing the JWT Certificate.

Possible Values

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

Data Type

string

Default Value

"GOOGLEJSONBLOB"

Remarks

Value	Description	Notes
USER	A certificate store owned by the current user.	Only available in Windows.
MACHINE	A machine store.	Not available in Java or other non-Windows environments.
PFXFILE	A PFX (PKCS12) file containing certificates.
PFXBLOB	A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	A Java key store (JKS) file containing certificates.	Only available in Java.
JKSBLOB	A string (base-64-encoded) representing a certificate store in Java key store (JKS) format.	Only available in Java.
PEMKEY_FILE	A PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	A string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	A file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	A file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	A string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	A PKCS7 file containing certificates.
PPKFILE	A file that contains a PPK (PuTTY Private Key).
XMLFILE	A file that contains a certificate in XML format.
XMLBLOB	Astring that contains a certificate in XML format.
BCFKSFILE	A file that contains an Bouncy Castle keystore.
BCFKSBLOB	A string (base-64-encoded) that contains a Bouncy Castle keystore.
GOOGLEJSON	A JSON file containing the service account information.	Only valid when connecting to a Google service.
GOOGLEJSONBLOB	A string that contains the service account JSON.	Only valid when connecting to a Google service.

Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.

Data Type

string

Default Value

""

Remarks

This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

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

Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Data Type

string

Default Value

"*"

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

• If an exact match for the subject is found, the corresponding certificate is selected.
• If no exact match is found, the store is searched for certificates whose subjects contain the property value.
• If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].

Common fields include:

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, enclose it in quotes. For example: "O=ACME, Inc.".

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application. Enter the value of the service account email address.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.

The user subject for which the application is requesting delegated access.

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address. Enter the email address of the user for which the application is requesting delegated access.

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

---

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

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

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

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

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.