MAIL Developer Overview

In this article we will look at MAIL from a developers perspective and provide you with the overview and references you need to get started.

Before getting started

In this concept article you can find an overview of MAIL, delving into its fundamental concepts and detailing its key features. If you haven't already, we highly recommend reading it.

API overview

MAIL is composed of a REST API that includes endpoints concerning mails, attachments, policies, providers, settings, and so forth. For a complete list of endpoints and models, refer to the Swagger API documentation.

Swagger API reference

Using the API

Given a valid authentication token here is an example of getting all mail policies:

1
2

curl -X GET https://myenv-mailapi.bizzkit.biz/api/mail-policies `
-H "Authorization: Bearer ..." `

1
2
3
4
5

# authtoken defined and initialized previously
@api = https://myenv-mailapi.bizzkit.biz

GET {{api}}/api/mail-policies HTTP/1.1
Authorization: Bearer {{authtoken}} 

Using the Bizzkit .NET SDK

For easy integration with Microsoft .NET, Bizzkit offers SDK packages. These packages include auto-generated Swagger clients and a factory class to simplify authentication. They automate token renewal and provide type-safe methods for the API endpoints.

All SDK package names start with the prefix Bizzkit.Sdk., and the SDK packages incorporate the following elements:

• A client factory
• A dedicated client
• Options to configure the client factory

To access the Bizzkit NuGet packages in your preferred development environment, you need to reference the Bizzkit Partner feed. You can, for example, do this by adding a nuget.config file to your project with the following configuration:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear />
    <add key="nuget" value="https://api.nuget.org/v3/index.json" />
    <add key="bizzkit-partner" value="https://pkgs.dev.azure.com/bizzkit-platform/7dad82b4-f2ae-4a3a-ab87-3fc791e4ea62/_packaging/bizzkit-partner-feed/nuget/v3/index.json" />
  </packageSources>
  <packageSourceMapping>
    <packageSource key="nuget">
      <package pattern="*" />
    </packageSource>
    <packageSource key="bizzkit-partner">
      <package pattern="Bizzkit*" />
    </packageSource>
  </packageSourceMapping>
</configuration>

This configuration clears existing package sources and adds the Bizzkit Partner feed alongside the official NuGet source.

Once the feed is configured, you can install the required NuGet package using the following command:

1

dotnet add package Bizzkit.Sdk.CloudMail

To simplify the authentication process, all NuGet packages associated with Bizzkit applications come with a factory class. This class streamlines the creation of an authenticated Swagger-generated client.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

using Bizzkit.Sdk.CloudMail;

var factory = new MailClientFactory(new MailConnectionOptions
{
    BaseUrl = "https://myenv-mailapi.bizzkit.biz",
    Authority = "https://myenv-auth.bizzkit.biz",
    ClientId = "BizzkitClient",
    ClientSecret = "BizzkitSecret",
    Scope = "mailapi/"
});

var client = await factory.CreateAuthenticatedClientAsync();

As noted earlier, the SDK client is mainly an auto-generated client based on the OpenAPI interface, meaning all methods map directly to the API.

Below is an example of calling the ListMailPolicies endpoint using the SDK client (with the factory and client already created):

1
2

var test = await client.ListMailPoliciesAsync();
test.ToList().ForEach(policy => Console.WriteLine(policy.Name));