Ready to get started?

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

Download Now

Create a Data Access Object for Email Data using JDBI

A brief overview of creating a SQL Object API for Email data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Email integrates connectivity to live Email data in Java applications. By pairing these technologies, you gain simple, programmatic access to Email data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Email data.

Create a DAO for the Email Mailboxes Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyMailboxesDAO { //insert new data into Email @SqlUpdate("INSERT INTO Mailboxes (Mailbox, RecentMessagesCount) values (:mailbox, :recentMessagesCount)") void insert(@Bind("mailbox") String mailbox, @Bind("recentMessagesCount") String recentMessagesCount); //request specific data from Email (String type is used for simplicity) @SqlQuery("SELECT RecentMessagesCount FROM Mailboxes WHERE Mailbox = :mailbox") String findRecentMessagesCountByMailbox(@Bind("mailbox") String mailbox); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Email

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Email.

The User and Password properties, under the Authentication section, must be set to valid credentials. The Server must be specified to retrieve emails and the SMTPServer must be specified to send emails.

Built-in Connection String Designer

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

java -jar cdata.jdbc.email.jar

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

A connection string for Email will typically look like the following:

jdbc:email:User=username@gmail.com;Password=password;Server=imap.gmail.com;Port=993;SMTP Server=smtp.gmail.com;SMTP Port=465;SSL Mode=EXPLICIT;Protocol=IMAP;Mailbox=Inbox;

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:email:User=username@gmail.com;Password=password;Server=imap.gmail.com;Port=993;SMTP Server=smtp.gmail.com;SMTP Port=465;SSL Mode=EXPLICIT;Protocol=IMAP;Mailbox=Inbox;"); MyMailboxesDAO dao = dbi.open(MyMailboxesDAO.class); //do stuff with the DAO dao.close();

Read Email Data

With the connection open to Email, simply call the previously defined method to retrieve data from the Mailboxes entity in Email.

//disply the result of our 'find' method String recentMessagesCount = dao.findRecentMessagesCountByMailbox("Spam"); System.out.println(recentMessagesCount);

Write Email Data

It is also simple to write data to Email, using the previously defined method.

//add a new entry to the Mailboxes entity dao.insert(newMailbox, newRecentMessagesCount);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Email by integrating with the CData JDBC Driver for Email. Download a free trial and work with live Email data in custom Java applications today.