How to Access Postmark Data Using Entity Framework

Microsoft Entity Framework serves as an object-relational mapping framework for working with data represented as objects. Although Visual Studio offers the ADO.NET Entity Data Model wizard to automatically generate the Entity Model, this model-first approach may present challenges when your data source undergoes changes or when you require greater control over entity operations. In this article, we will delve into the code-first approach for accessing Postmark data through the CData ADO.NET Provider, providing you with more flexibility and control.

1. Open Visual Studio and create a new Windows Form Application. This article uses a C# project with .NET 4.5.
2. Run the command 'Install-Package EntityFramework' in the Package Manger Console in Visual Studio to install the latest release of Entity Framework.

3. Modify the App.config file in the project to add a reference to the Postmark Entity Framework 6 assembly and the connection string.

   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.

   <configuration>
    ... 
    <connectionStrings>
    <add name="APIContext" connectionString="Offline=False;Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"" providerName="System.Data.CData.API" />
    </connectionStrings>
    <entityFramework>
    <providers>
    ... 
    <provider invariantName="System.Data.CData.API" type="System.Data.CData.API.APIProviderServices, System.Data.CData.API.Entities.EF6" />
    </providers>
    <entityFramework>
   </configuration>
   </code> 
   

4. Add a reference to System.Data.CData.API.Entities.EF6.dll, located in the lib -> 4.0 subfolder in the installation directory.
5. Build the project at this point to ensure everything is working correctly. Once that's done, you can start coding using Entity Framework.
6. Add a new .cs file to the project and add a class to it. This will be your database context, and it will extend the DbContext class. In the example, this class is named APIContext. The following code example overrides the OnModelCreating method to make the following changes:
   • Remove PluralizingTableNameConvention from the ModelBuilder Conventions.
   • Remove requests to the MigrationHistory table.

   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   
   class APIContext : DbContext {
    public APIContext() { }
   
    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
    // To remove the requests to the Migration History table
    Database.SetInitializer<APIContext>(null); 
    // To remove the plural names 
    modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
    } 
   }
   

7. Create another .cs file and name it after the Postmark entity you are retrieving, for example, Bounces. In this file, define both the Entity and the Entity Configuration, which will resemble the example below:

   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   
   [System.ComponentModel.DataAnnotations.Schema.Table("Bounces")]
   public class Bounces {
    [System.ComponentModel.DataAnnotations.Key] 
    public System.String { get; set; }
    public System.String { get; set; }
   }
    
   

8. Now that you have created an entity, add the entity to your context class:

   public DbSet<Bounces> Bounces { set; get; }
   

9. With the context and entity finished, you are now ready to query the data in a separate class. For example:

   APIContext context = new APIContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Bounces select line;