MVFC.Aspire.Helpers.Mailpit 8.0.1

MVFC.Aspire.Helpers.Mailpit

🇧🇷 Leia em Português

Helpers for integrating with the MailPit SMTP emulator in .NET Aspire projects, easing the testing of email delivery in development environments.

Motivation

Testing e‑mail locally often means:

• Pointing your app to a real SMTP server or a fragile test server.
• No safe way to inspect messages without actually sending them.
• Manual setup of Mailpit/Mailhog containers per project.

With .NET Aspire you can define the container, but you still need to:

• Configure SMTP and web ports.
• Decide where to persist Mailpit data.
• Wire your applications to the SMTP host/port.

MVFC.Aspire.Helpers.Mailpit offers:

• AddMailpit(...) to provision the SMTP emulator.
• Fluent options for max messages, authentication, data file path and logging.
• WithReference(...) to connect projects to Mailpit.

Overview

This project allows adding and integrating MailPit as a managed resource in distributed .NET Aspire applications. It simplifies provisioning the MailPit container, exposes the web interface to view received emails, and provides extension methods for AppHost configuration.

Project Structure

• MVFC.Aspire.Helpers.Mailpit: Helpers and extensions library for MailPit.

Features

• Adds the MailPit container to the Aspire application.
• Exposes the web interface for visualizing received emails.
• Extension methods to facilitate AppHost configuration.
• Allows configuration of port, maximum number of messages, authentication, and optional data persistence.

Compatible Images

• axllent/mailpit

Installation

dotnet add package MVFC.Aspire.Helpers.Mailpit

Quick Aspire usage (AppHost)

using Aspire.Hosting;
using MVFC.Aspire.Helpers.Mailpit;

var builder = DistributedApplication.CreateBuilder(args);

var mailpit = builder.AddMailpit("mailpit")
    .WithMaxMessages(1000)
    .WithDataFilePath("/data/mailpit.db")
    .WithWebAuth(username: "admin", password: "secret");

builder.AddProject<Projects.MVFC_Aspire_Helpers_Playground_Api>("api-example")
       .WithReference(mailpit)
       .WaitFor(mailpit);

await builder.Build().RunAsync();

Provisioning diagram

sequenceDiagram
    participant Aspire as .NET Aspire
    participant Container as Mailpit Container
    
    Aspire->>Container: Start container (axllent/mailpit)
    Container-->>Aspire: Ready (SMTP and UI ports available)
    Aspire->>App: Start App with SMTP ConnectionString

Fluent methods

AddMailpit parameters

Ports and visualization

• SMTP port: smtpPort (default 1025).
• Web port: httpPort (default 8025).
• Web UI: http://localhost:<httpPort>/.

Requirements

• .NET 9+
• Aspire.Hosting >= 9.5.0

License

Apache-2.0