How changemakerstudios/papercut-smtp works
Project Type and Purpose
• This is “Papercut SMTP,” a .NET-based full-stack application that combines:
• An embedded SMTP server (development-only mail sink)
• A domain-driven backend (message storage, rules engine, message bus)
• A desktop front end (WPF/UI) plus an HTML/JS UI hosted in‐process or via Electron
• An optional HTTP/REST service with Web UI and Docker support
High-Level File-Structure Analysis
• Top‐Level Solution (Papercut.sln)
• build/*, Dockerfile, Cake scripts for CI/CD
• chocolatey/ and extras/ for packaging & install scripts
• src/Common, Core, Message, Rules, Infrastructure.* – Core libraries
• Domain model (IMessage, ICommand, IEvent, Rules, Paths, Settings)
• Infrastructure (Async, Logging, JSON, MessageBus, Container modules)
• src/Infrastructure.IPComm & Infrastructure.Smtp – pluggable network protocols
• src/Service – NUnit-hosted SMTP service + ASP.NET Core HTTP API + static Web assets + SignalR hub
• src/UI – WPF desktop application (MVVM + Autofac DI + WebView2 for HTML UI)
• test/ – Web API integration tests
README Insights
• Primary use case: capture outgoing development emails safely
• Features: SMTP listener on port 25, instant notifications, full MIME inspection, optional HTTP service on port 80/8080
a. Main Components to Model
1. SMTP Listener
• Papercut.Core’s SMTP server implementation (Papercut.Infrastructure.Smtp)
2. Domain & Business Logic
• Papercut.Core (Domain + Infrastructure modules)
• Rules Engine (Papercut.Rules)
• Message Repository (Papercut.Message)
3. Message Bus
• AutofacMessageBus (publish/subscribe events internally)
4. Persistence / Storage
• File-system based JSON store (JsonSettingStore + message files under configured paths)
5. Backend Service Host
• ASP.NET Core WebHost (Controllers, Static Content, SignalR NewMessagesHub)
• In-process HTTP server for desktop standalone mode
6. Desktop UI
• WPF MVVM app (Papercut.UI)
• WebView2 or Electron host loading HTML/JS SPA
• IPComm channel for event & command exchange between UI and service
7. External Interfaces
• SMTP protocol ingress (port 25)
• HTTP/REST ingress (port 80/8080)
• IPComm (custom TCP loopback channel)
b. Relationships & Data Flows
1. SMTP Client → SMTP Listener
2. Listener publishes NewMessageEvent on MessageBus
3. RulesRunner consumes events, applies Rules, writes Message files
4. MessageRepository reads stored messages
5. HTTP Controllers and SignalR Hub expose messages & notifications
6. Desktop UI connects via IPComm or HTTP/SignalR to receive NewMessage notifications and query messages
7. WPF view models bind to HTML/JS UI via WebView2 or native controls
c. Architectural Patterns & Principles
• Layered Architecture (Domain / Infrastructure / Service / UI)
• Dependency Injection with Autofac modules (PapercutCoreModule, PapercutMessageModule, etc.)
• Publish/Subscribe MessageBus for decoupling components
• Modular design via separate projects & NuGet packaging (Common, Core, Infrastructure, Message, Rules, UI, Service)
• In-Process hosting for desktop convenience, plus optional Dockerized container for headless service
d. Key Technologies & Frameworks
• .NET (Framework & .NET Core)
• Autofac (DI)
• Cake & PowerShell (build automation)
• WPF + MVVM (Papercut.UI)
• WebView2 / Electron (HTML/JS UI)
• ASP.NET Core MVC & SignalR (Papercut.Service Web API)
• Custom IPComm protocol (loopback socket for UI ↔ service coordination)
• File-system JSON storage (message + settings persistence)