How to Query Postmark Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Postmark to query Postmark data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Postmark data in MySQL Workbench.

Connect to Postmark 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.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Postmark 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.

Query Postmark from MySQL Workbench

The steps below outline connecting to the virtual Postmark database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Postmark data.

Connect to Postmark through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Postmark).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Postmark Data

1. Open the connection you just created (CData SQL Gateway for Postmark).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Postmark data, like SELECT * FROM `CData API Sys`.Bounces;

With access to live Postmark data from MySQL Workbench, you can easily work with Postmark, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.