NetEvolve.HealthPublishers.Email 1.13.10

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package NetEvolve.HealthPublishers.Email --version 1.13.10
                    


                    

                
NuGet\Install-Package NetEvolve.HealthPublishers.Email -Version 1.13.10
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="NetEvolve.HealthPublishers.Email" Version="1.13.10" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="NetEvolve.HealthPublishers.Email" Version="1.13.10" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NetEvolve.HealthPublishers.Email" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add NetEvolve.HealthPublishers.Email --version 1.13.10
                    


                    

                
#r "nuget: NetEvolve.HealthPublishers.Email, 1.13.10"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package NetEvolve.HealthPublishers.Email@1.13.10
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=NetEvolve.HealthPublishers.Email&version=1.13.10
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NetEvolve.HealthPublishers.Email&version=1.13.10
                    


                            Install as a Cake Tool

NetEvolve.HealthPublishers.Email

NuGet Version NuGet Downloads License

An IHealthCheckPublisher implementation that sends HealthReport results as an email, using MailKit to connect directly to an SMTP server.

Features

  • Sends a single plain-text email per publish, summarizing the overall report status, elapsed time, and a per-check breakdown
  • Subject line includes the overall HealthStatus and the configured SystemIdentifier, for quick triage in an inbox
  • Tags every email with the machine name and a required, free-form SystemIdentifier to tell instances apart
  • Supports connecting without authentication, or with username/password credentials, over plain, StartTls, or implicit TLS/SSL connections
  • Configuration- or builder-based setup, consistent with the NetEvolve.HealthPublishers.* conventions
  • Named registrations to send to multiple SMTP servers or recipient lists side by side
  • Debounces notifications instead of emailing on every publish: a worsening status is emailed immediately, while an improving status must stay sustained for a configurable delay before a "recovery" email is sent
  • Includes a timestamp in the email body, converted to a configurable time zone (defaults to Europe/Berlin)

Installation

NuGet Package Manager

Install-Package NetEvolve.HealthPublishers.Email

.NET CLI

dotnet add package NetEvolve.HealthPublishers.Email

PackageReference

<PackageReference Include="NetEvolve.HealthPublishers.Email" Version="x.x.x" />

Quick Start

using NetEvolve.HealthPublishers.Email;

var builder = services.AddHealthChecks();

builder.AddEmailPublisher(options =>
{
    options.Host = "smtp.example.com";
    options.Port = 587;
    options.From = "health-checks@example.com";
    options.To = ["ops-team@example.com"];
    options.SystemIdentifier = "checkout-service";
});

Usage

Basic Example

Register under the default name ("Default"), configured via code:

var builder = services.AddHealthChecks();

builder.AddEmailPublisher(options =>
{
    options.Host = "smtp.example.com"; // Required
    options.Port = 587; // Required
    options.From = "health-checks@example.com"; // Required
    options.To = ["ops-team@example.com"]; // Required, at least one address
    options.SystemIdentifier = "checkout-service"; // Required, tags the email alongside the machine name
    options.Username = "smtp-user"; // Optional, requires Password to be set as well
    options.Password = "<password>"; // Optional, requires Username to be set as well
});

Notification Behavior

The publisher keeps track of the HealthStatus it last actually emailed about (per registered instance) and does not send an email for every PublishAsync call:

  • Same status as last notified: no email is sent.
  • Worsening status (e.g. Healthy → Degraded, Degraded → Unhealthy, or Healthy → Unhealthy): an email is sent immediately, regardless of RecoveryConfirmationDelay.
  • Improving status (e.g. Degraded → Healthy, Unhealthy → Degraded, or Unhealthy → Healthy): the improvement must be sustained for at least RecoveryConfirmationDelay before a "recovery" email is sent. If the status regresses back to the last-notified status before the delay elapses, no email is sent and the delay resets; a later improvement starts a new delay from scratch. If the status regresses to something worse than the last-notified status instead, that is treated as a new worsening event and is emailed immediately.

Advanced Example

Register multiple named Email targets, each sending the same health reports to a different SMTP server or recipient list:

var builder = services.AddHealthChecks();

builder.AddEmailPublisher("Internal", options =>
{
    options.Host = "smtp.example.com";
    options.Port = 587;
    options.From = "health-checks@example.com";
    options.To = ["internal-ops@example.com"];
    options.SystemIdentifier = "checkout-service";
});
builder.AddEmailPublisher("External", options =>
{
    options.Host = "smtp-external.example.com";
    options.Port = 587;
    options.From = "health-checks@example.com";
    options.To = ["external-ops@example.com"];
    options.SystemIdentifier = "checkout-service";
});

Configuration

Code-based

builder.AddEmailPublisher(options =>
{
    options.Host = "smtp.example.com"; // Required
    options.Port = 587; // Required
    options.SecureSocketOptions = SecureSocketOptions.StartTls; // Optional, defaults to SecureSocketOptions.Auto
    options.From = "health-checks@example.com"; // Required
    options.To = ["ops-team@example.com"]; // Required
    options.SystemIdentifier = "checkout-service"; // Required
    options.Username = "smtp-user"; // Optional
    options.Password = "<password>"; // Optional
    options.RecoveryConfirmationDelay = TimeSpan.FromMinutes(10); // Optional, defaults to 5 minutes, minimum 5 minutes
    options.TimeZoneId = "Europe/Berlin"; // Optional, defaults to "Europe/Berlin"
});

appsettings.json-based

builder.AddEmailPublisher(); // reads the "Default" section below

{
  "HealthPublishers": {
    "Email": {
      "Default": {
        "Host": "smtp.example.com",
        "Port": 587,
        "SecureSocketOptions": "StartTls",
        "From": "health-checks@example.com",
        "To": ["ops-team@example.com"],
        "SystemIdentifier": "checkout-service",
        "Username": "smtp-user",
        "Password": "<password>",
        "RecoveryConfirmationDelay": "00:10:00",
        "TimeZoneId": "Europe/Berlin"
      }
    }
  }
}

When using an explicit name, the section key must match: builder.AddEmailPublisher("Internal") reads HealthPublishers:Email:Internal.

Requirements

  • .NET 8.0 or higher
  • A reachable SMTP server

Documentation

For complete documentation, please visit the official documentation.

Contributing

Contributions are welcome! Please read the Contributing Guidelines before submitting a pull request.

Support

License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ by the NetEvolve Team Visit us at https://www.daily-devops.net for more information about our services and solutions.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.13.10 25 8/23/2026

https://github.com/dailydevops/healthpublishers/releases/