Sidio.MailBluster 1.0.0

Sidio.MailBluster

Sidio.MailBluster is an unofficial C# SDK for the MailBluster API. This package is not yet fully feature complete, see the feature status below. If you encounter any issues or have recommendations, feel free to create an issue or a pull request.

Installation

Add the package to your project.

Usage

Options

{
  "MailBluster:Url": "https://api.mailbluster.com/api/",
  "MailBluster:ApiKey": "your-api-key"
}

Dependency injection

services.AddMailBluster();

Using the client

public class MyClass
{
    private readonly IMailBlusterClient _client;

    public MyClass(IMailBlusterClient client)
    {
        _client = client;        
    }

     public async Task GetLeads()
     {
          var lead = await _client.GetLeadAsync("noreply@sidio.nl");
    }
}

Logging

⚠️ Be aware when the log level Trace is used, sensitive data (e.g. email address, names) might be logged. It is recommended not to use trace logging in production environments.

Feature status

• Manage leads
  • Create
  • Read
  • Update
  • Delete
• Manage fields
  • Create
  • Read
  • Update
  • Delete
• Manage products
  • Create
  • Read
  • Update
  • Delete
• Manage orders
  • Create
  • Read
  • Update
  • Delete

Integration tests

Integration tests are available in the Sidio.MailBluster.Integration.Tests project. To run the tests, add the following configuration file local.settings.json:

{
  "MAILBLUSTER_API_KEY": "your-api-key"
}

Note:

• The integration tests will create, update and delete data in your MailBluster brand associated with the API key.
• In order to run the tests for Fields, a pro account is required.

API Documentation

• MailBluster API

Disclaimer

This package is not affiliated with MailBluster. Although we try to cover the API as much as possible using unit- and integration testing, we cannot guarantee that all features or error states have been implemented. Please use at your own risk.

Sponsors

Many thanks to MailBluster for providing us with a pro account.