Rapidly Develop Postmark-Driven Apps with Active Query Builder
Write standard .NET to expose Postmark data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Postmark enables standards-based access to Postmark. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.
Connect to Postmark as an ODBC Data Source
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.
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.
Use SQL to Interact with Postmark
Follow the steps below to create a WinForms visual query builder.
- Open Active Query Builder for .NET WinForms.
- In the new Windows Forms project go to the "File" menu and click "Connect..."
- Under Database Connections, click "Add..."
- Set your desired Connection Name (e.g. CData Postmark), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
- Click "OK" to save the new connection.
- Back in the Database Connection wizard, select the newly created connection and click "OK."
- Click "File" > "New Query" to create a QueryBuilder
You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.