Connect to Postmark Data from Blazor Apps

Cameron Leblanc
Cameron Leblanc
Senior Technology Evangelist
Build ASP.NET Core Blazor C# apps that integrate with real-time Postmark data using standard SQL.

Blazor is a framework for developing modern, client-side web UIs using .NET technology. Instead of coding in JavaScript, developers can use the familiar C# language and .NET libraries to build app UIs.

The CData API Driver for ADO.NET can be used with standard ADO.NET interfaces, such as LINQ and Entity Framework, to interact with live Postmark data. Since Blazor supports .NET Core, developers can use CData ADO.NET Providers in Blazor apps. In this article, we will guide you to build a simple Blazor app that talks to Postmark using standard SQL queries.

Install the CData API Driver for ADO.NET

CData ADO.NET Providers allow users to access Postmark just like they would access SQL Server, using simple SQL queries.

Install the Postmark ADO.NET Data Provider from the CData website or from NuGet. Search NuGet for "Postmark ADO.NET Data Provider."

Create a Postmark-Connected Blazor App

Start by creating a Blazor project that references the CData API Driver for ADO.NET

  1. Create a Blazor project on Visual Studio.
  2. From the Solution Explorer, right click Dependencies, then click Add Project Reference.
  3. In the Reference Manager, click the Browse button, and choose the .dll file of the installed ADO.NET Provider (e.g. System.Data.CData.API.dll, typically located at C:\Program Files\CData\CData API Driver for ADO.NET\lib etstandard2.0).

SELECT Postmark Data from the Blazor App

  1. Open the Index.razor file from the Project page.
  2. In a APIConnection object, set 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.

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

  3. The code below creates a simple Blazor app for displaying Postmark data, using standard SQL to query Postmark just like SQL Server.

          @page "/"
          @using System.Data;
          @using System.Data.CData.API;
          
          <h1>Hello, world!</h1>
          
          Welcome to your Data app.
          
          <div class="row">
              <div class="col-12">
          
                  @using (APIConnection connection = new APIConnection(
                    "Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token""))
                  {
                      var sql = "SELECT ,  FROM Bounces WHERE  = ''";
                      var results = new DataTable();
          
                      APIDataAdapter dataAdapter = new APIDataAdapter(sql, connection);
                      dataAdapter.Fill(results);
          
                      <table class="table table-bordered">
                          <thead class="thead-light">
                              <tr>
                                  @foreach (DataColumn item in results.Rows[0].Table.Columns)
                                  {
                                      <th scope="col">@item.ColumnName</th>
                                  }
                              </tr>
                          </thead>
                          <tbody>
                              @foreach (DataRow row in results.Rows)
                              {
                                  <tr>
                                      @foreach (var column in row.ItemArray)
                                      {
                                          <td>@column.ToString()</td>
                                      }
                                  </tr>
                              }
                          </tbody>
                      </table>
                  }
              </div>
          </div>
        
  4. Rebuild and run the project. The ADO.NET Provider renders Postmark data as an HTML table in the Blazor app.

    At this point, you have a Postmark-connected Blazor app, capable of working with live Postmark data just like you would work with a SQL Server instance. Download a free, 30-day trial and start working with live Postmark data in your Blazor apps today.

Ready to get started?

Connect to live data from Postmark with the API Driver

Connect to Postmark