Ready to get started?

Learn more about the CData JDBC Driver for Gmail or download a free trial:

Download Now

Query Gmail Data in ColdFusion

Write standard ColdFusion data access code to connect to Gmail data.

The CData JDBC Driver for Gmail seamlessly integrates connectivity to Gmail data with the rapid development tools in ColdFusion. This article shows how to connect to Gmail data in ColdFusion and query Gmail tables.

Create a JDBC Data Source for Gmail in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:gmail: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

      There are two ways to authenticate to Gmail. Before selecting one, first ensure that you have enabled IMAP access in your Gmail account settings. See the "Connecting to Gmail" section under "Getting Started" in the installed documentation for a guide.

      The User and Password properties, under the Authentication section, can be set to valid Gmail user credentials.

      Alternatively, instead of providing the Password, you can use the OAuth authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.

      OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, you will need to register an application to obtain the OAuth JWT values.

      In addition to the OAuth values, you will need to provide the User. See the "Getting Started" chapter in the help documentation for a guide to using OAuth.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Gmail JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.gmail.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      A typical JDBC URL is below:

      jdbc:gmail:User=username;Password=password;
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.gmail.GmailDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData Gmail data source in the Actions column. After reporting a status of OK, the Gmail data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to Gmail, including INSERT, UPDATE, and DELETE.. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="GmailQuery" dataSource="CDataGmail"> SELECT * FROM Inbox WHERE From = <cfqueryparam value="#From#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#GmailQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM Inbox WHERE From = ?", 
  [
    { value="test@test.com", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataGmail" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?From=test@test.com