DataBind Controls to Gmail Data in C++Builder

Ready to get started?

Download for a free trial:

Download Now

Learn more:

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.



DataBind to Gmail data in C++Builder with standard components and controls.

The CData ODBC Driver for Gmail makes it easy to integrate connectivity to live Gmail data with standard data access components in C++Builder. This article shows how to create a simple visual component library (VCL) application in C++Builder that connects to Gmail data, executes queries, and displays the results in a grid. An additional section shows how to use FireDAC components to execute commands from code.

Create a FireDAC Connection to Gmail Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Gmail.

  1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Gmail.

Create VCL Applications with Connectivity to Gmail Data

Follow the procedure below to start querying Gmail data from a simple VCL application that displays the results of a query in a grid.

  1. Drop a TFDConnection component onto the form and set the following properties:

    • ConnectionDefName: Select the FireDAC connection to Gmail.
    • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.
  2. Drop a TFDQuery component onto the form and set the properties below:

    • Connection: Set this property to the TFDConnection component, if this component is not already specified.
    • SQL: Click the button in the SQL property and enter a query. For example:

      SELECT Subject, Size FROM Inbox
    • Active: Set this property to true.
  3. Drop a TDataSource component onto the form and set the following property:

    • DataSet: In the menu for this property, select the name of the TFDQuery component.
  4. Drop a TDBGrid control onto the form and set the following property:

    • DataSource: Select the name of the TDataSource.
  5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

Execute Commands to Gmail with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to Gmail data. This section provides Gmail-specific examples of executing queries with the TFQuery component.

Connect to Gmail Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1->ConnectionDefName = "CData Gmail ODBC Source"; FDConnection1->Connected = true;

To connect the TFDQuery component to Gmail data, set the Connection property of the component. When a TFDQuery component is added at design time, its Connection property is automatically set to point to a TFDConnection on the form, as in the application above.

Create Parameterized Queries

To create a parameterized query, use the following syntax below:

FDQuery1->SQL->Text = "select * from Inbox where from = :From"; FDQuery1->ParamByName("from")->AsString = "test@test.com"; query->Open();

The example above binds a string-type input parameter by name and then opens the dataset that results.

Prepare the Statement

Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1->SQL->Text := "select * from Inbox where from = :From"; FDQuery1.ParamByName("from")->AsString = "test@test.com"; FDQuery1->Open();

To execute a query that does not return a result set, use the ExecSQL method. The ExecSQL method will return an error if the query returns a result set. To retrieve the count of affected rows use the TFD.RowsAffected property.

FDQ.SQL.Text := "delete from Inbox where Id = :Id"; FDQuery1->Params->Items[0]->AsString = "x12345"; FDQuery1->ExecSQL(); AnsiString i = FDQuery1->RowsAffected;