Ready to get started?

Download a free trial of the Gmail ODBC Driver to get started:

 Download Now

Learn more:

Gmail Icon Gmail ODBC Driver

The Gmail ODBC Driver is a powerful tool that allows you to connect with live Internet E-mail (Gmail), directly from any applications that support ODBC connectivity.

Access Gmail folders and message data like you would a database - read, write, and send E-mails through a standard ODBC Driver interface.

Query Gmail Data as a MySQL Database in Node.js



Execute MySQL queries against Gmail data from Node.js.

You can use the SQL Gateway from the ODBC Driver for Gmail to query Gmail data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and start querying using Node.js.

Connect to Gmail Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Gmail data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query Gmail from Node.js

The following example shows how to define a connection and execute queries to Gmail with the mysql module. You will need the following information:

  • Host name or address, and port: The machine and port where the MySQL remoting service is listening for MySQL connections.
  • Username and password: The username and password of a user you authorized on the Users tab of the SQL Gateway.
  • Database name: The DSN you configured for the MySQL remoting service.

Connect to Gmail data and start executing queries with the code below:

var mysql      = require('mysql');
var connection = mysql.createConnection({
  host     : 'localhost',
  database : 'CData Gmail Sys',
  port	   : '3306',
  user     : 'mysql_user',
  password : 'test'
});
connection.connect();
connection.query('SELECT * FROM Inbox', function(err, rows, fields) {
  if (err) throw err;
  console.log(rows);
});

connection.end();