Working with Postmark Data in LINQPad

The CData ADO.NET Provider for Postmark enables you to use standard ADO.NET interfaces like LINQ and the Entity Framework to work with Postmark data. This article will demonstrate the process of establishing a connection from LINQPad and executing LINQ queries.

Create the Data Model

After downloading and installing both the provider and LINQPad, create a new class library project within Visual Studio.

See the help documentation for a guide to setting up an EF 6 project to use the provider.

1. Right-click your project and click Add -> New Item -> ADO.NET Entity Data Model. In the resulting dialog, select Code First from database. Click New Connection and specify the connection string options in the resulting wizard.

   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.

   Below is a typical connection string:

   Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"

   👁 The required connection properties in the Entity Data Model Configuration Wizard. (JSON is shown.)
   

2. Select the desired tables and views and click Finish to create the data model.

   👁 The last step of the Entity Data Model Configuration Wizard, where tables are imported into the entity model.
   
3. Build the project. The generated files can be used to create the Postmark connection in LINQPad.

Connect to Postmark Data in LINQPad

After you have obtained the required connection properties and created the data model assembly, follow the steps below to start using the data model in LINQPad.

1. Open LINQPad and click Add Connection.

2. Select the "Use a typed data context from your own assembly" option.

3. Select Entity Framework DbContext.

   👁 The Choose Data Context dialog.
   

4. Click Browse next to the Path to Custom Assembly box and browse to your project folder. Browse to the .dll or .exe under the bin folder.

5. Select the name of the DbContext.
6. If you saved your connection string in App.Config, specify the path to the App.config.

You can now query Postmark data through LINQPad. For examples of the supported LINQ queries, see the "LINQ and Entity Framework" chapter in the help documentation.