OAuth Authentication
Use the OAuth authentication standard to connect to Gmail. You can authenticate with a user account.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 connecting, see Establishing a Connection.| Auth Scheme | The type of authentication to use when connecting to Gmail. |
| Auto Cache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| Cache Connection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| Cache Location | Specifies the path to the cache when caching to a file. |
| Cache Metadata | This property determines whether or not to cache the table metadata to a file store. |
| Cache Provider | The name of the provider to be used to cache data. |
| Cache Tolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Callback URL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
| Connection Life Time | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| Firewall Password | A password used to authenticate to a proxy-based firewall. |
| Firewall Port | The TCP port for a proxy-based firewall. |
| Firewall Server | The name or IP address of a proxy-based firewall. |
| Firewall Type | The protocol used by a proxy-based firewall. |
| Firewall User | The user name to use to authenticate with a proxy-based firewall. |
| Include Message | Whether to include message body content and attachment data or not. |
| Initiate OAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| Is HTML | Determines whether the MesssageBody is HTML or plain-text. |
| Keep Alive | The IMAP connection should be kept alive when this value is true. |
| List Mailboxes | Whether to list all mailboxes or just the subscribed IMAP mailboxes. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A filepath which designates the name and location of the log file. |
| Log Modules | Core modules to be included in the log file. |
| Max Items | Maximum number of items to return. |
| Max Log File Count | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
| Max Log File Size | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
| Max Rows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| OAuth Access Token | The access token for connecting using OAuth. |
| OAuth Client Id | The client ID assigned when you register your application with an OAuth authorization server. |
| OAuth Client Secret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuth Expires In | The lifetime in seconds of the OAuth AccessToken. |
| OAuth JWT Cert | The JWT Certificate store. |
| OAuth JWT Cert Password | The password for the OAuth JWT certificate. |
| OAuth JWT Cert Subject | The subject of the OAuth JWT certificate. |
| OAuth JWT Cert Type | The type of key store containing the JWT Certificate. |
| OAuth JWT Issuer | The issuer of the Java Web Token. |
| OAuth JWT Subject | The user subject for which the application is requesting delegated access. |
| OAuth Refresh Token | The OAuth refresh token for the corresponding OAuth access token. |
| OAuth Settings Location | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://. |
| OAuth Token Timestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| OAuth Verifier | The verifier code returned from the OAuth authorization URL. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | These hidden properties are used only in specific use cases. |
| Password | The password of the Gmail account used to authenticate. |
| Peek Mode | When true PEEK is added to all FETCH commands sent to IMAP. Used to avoid setting the /Seen flag. |
| Pool Idle Timeout | The allowed idle time for a connection before it is closed. |
| Pool Max Size | The maximum connections in the pool. |
| Pool Min Size | The minimum number of connections in the pool. |
| Pool Wait Time | The max seconds to wait for an available connection. |
| Proxy Auth Scheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| Proxy Auto Detect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| Proxy Exceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Proxy Password | A password to be used to authenticate to the ProxyServer proxy. |
| Proxy Port | The TCP port the ProxyServer proxy is running on. |
| Proxy Server | The hostname or IP address of a proxy to route HTTP traffic through. |
| Proxy SSL Type | The SSL type to use when connecting to the ProxyServer proxy. |
| Proxy User | A user name to be used to authenticate to the ProxyServer proxy. |
| Pseudo Columns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Query Full Details | Determines whether to include full details of messages. |
| Readonly | You can use this property to enforce read-only access to Gmail from the provider. |
| RTK | The runtime key used for licensing. |
| Schema | Used to specify what Gmail Api to use. The default one is the IMAP. |
| SSL Server Cert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Support Enhanced SQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UID Mode | If true, permanent message Ids are used instead of the default temporary Ids. |