Import Real-Time Postmark Data via JDBC in ColdFusion to Build Applications
Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST.
When ColdFusion is paired with the CData API Driver for JDBC, you can link your ColdFusion web and mobile applications to operational Postmark data. This allows for your applications to be more robust and complete. This article details how to use the JDBC driver to create a table populated with Postmark data from within a ColdFusion markup file.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Postmark data. When you issue complex SQL queries to Postmark, the driver pushes supported SQL operations, like filters and aggregations, directly to Postmark and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Postmark data using native data types.
Configuring the Connection to Postmark
You will need a JDBC connection string to establish a connection between Coldfusion and Postmark.
Using API Key Authentication
Postmark uses server API tokens to authenticate requests. Each Postmark server has its own API token, which controls access to messages, bounces, templates, and statistics associated with that server.
To obtain your Server API Token, log in to your Postmark account and navigate to the server you want to connect to. Go to API Tokens under the server settings and copy the token labeled Server API token.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Postmark Server API Token. This value is sent as the X-Postmark-Server-Token header on every request.
Example connection string:
Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
Connecting to Postmark
Once the authentication is configured, you can connect to Postmark and query data from any of the available tables such as OutboundMessages, Bounces, and Templates.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Postmark JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.api.jar
Adding a Data Source and Creating a Table
After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with Postmark data and display it in a table written in the ColdFusion Markup Language, or CFML:
-
Copy the JDBC Driver for Postmark and lic file from "C:\Program Files\CData[product_name]\lib" to
"C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".
cdata.jdbc.api.jar cdata.jdbc.api.licNote: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.
-
From the ColdFusion administrator interface, choose Data & Services.
-
Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion
variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button.
-
Next, populate the driver properties.
- JDBC URL will need to be in the format: jdbc:api:|connectionString|.
- A typical connection string looks like this:
jdbc:api:Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
- The Driver Class is: cdata.jdbc.api.APIDriver
- The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
-
Now, test the connection by clicking the check mark to the left of the CDataPostmarkJDBC data source you just created.
When the data source reports an "OK" status, it is ready for use.
-
Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot")
for ColdFusion.
The following code queries the data source:
<cfquery name="PostmarkQuery" dataSource="CDataPostmarkJDBC"> SELECT * FROM Bounces </cfquery>And a CFTable can be used to quickly output the table in HTML:<cftable query = "PostmarkQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"> <cfcol header="<b></b>" align="Left" width=2 text=""/> <cfcol header="<b></b>" align="Left" width=15 text=""/> ... </cftable>Full code, including the HTML portion is available below:<html> <head><title>CData Software | Postmark Bounces Table Demo </title></head> <body> <cfoutput>#ucase("Postmark Bounces Table Demo")#</cfoutput> <cfquery name="PostmarkQuery" dataSource="CDataPostmarkJDBC"> SELECT * FROM Bounces </cfquery> <cftable query = "PostmarkQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"> <cfcol header="<b></b>" align="Left" width=2 text=""/> <cfcol header="<b></b>" align="Left" width=15 text=""/> ... </cftable> </body> </html> -
Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with Postmark data!
As a note, the CData JDBC Drivers also support parameterized queries using the cfqueryparam element. For example:
SELECT * FROM Account WHERE name =
Get Started Today
Download a free, 30-day trial of the CData JDBC Driver for Postmark and start building Postmark-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.