Skip to main content
The Paubox C# SDK is the official .NET client library for the Paubox Email API and Paubox Forms. It provides a strongly-typed interface for sending encrypted email, managing dynamic templates, tracking delivery, and submitting forms.

Installation

The SDK is not published to NuGet. The lib/Paubox.Email.API.dll committed to the repository dates from 2019 and only supports sending a message and checking its disposition, so do not reference it. Instead, either reference the SDK project from a clone of the repository, or download the Paubox.Email.API-<version>.dll asset from the latest GitHub release. Project reference (recommended):
DLL reference: build the DLL yourself with dotnet build Paubox_Csharp/EmailLib/EmailLib.csproj --configuration Release (output: Paubox_Csharp/EmailLib/bin/Release/net8.0/Paubox.Email.API.dll) or use the release asset, then reference it and add the packages it depends on:

What you can do

  • Send encrypted, HIPAA compliant email to one or more recipients
  • Send batches of up to 50 messages in a single API call
  • Create, update, and delete dynamic Handlebars templates
  • Send templated messages with per-message variable substitution
  • Track delivery status and engagement per recipient
  • Schedule, reschedule, and cancel messages
  • Retrieve Paubox Form schemas and submit form responses with file attachments
  • Manage forms, submissions, and exports with a forms-scoped API key
  • Manage receiving domains and mailboxes, and read inbound email
  • Manage webhook endpoints

Requirements

  • .NET 8.0 or later (.NET 9.0 also supported)

Dependency injection

The SDK ships with IEmailLibrary, IFormsLibrary, IReceivingLibrary, and IWebhookLibrary interfaces, making it straightforward to register the clients in an ASP.NET Core DI container and mock them in tests.

Get started

Quickstart

Add the SDK, configure credentials, and send your first email in minutes.

Authentication

Configure via constructor params or appsettings.json.

Email client

Full reference for sending email, managing templates, and tracking delivery.

Forms client

Retrieve form schemas and submit responses.

Receiving client

Manage receiving domains and mailboxes, and read inbound email.

Webhook client

Create and manage webhook endpoints.