MailStencil.FileSystem 0.1.0-preview.1

This is a prerelease version of MailStencil.FileSystem.
dotnet add package MailStencil.FileSystem --version 0.1.0-preview.1
                    
NuGet\Install-Package MailStencil.FileSystem -Version 0.1.0-preview.1
                    
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="MailStencil.FileSystem" Version="0.1.0-preview.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MailStencil.FileSystem" Version="0.1.0-preview.1" />
                    
Directory.Packages.props
<PackageReference Include="MailStencil.FileSystem" />
                    
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 MailStencil.FileSystem --version 0.1.0-preview.1
                    
#r "nuget: MailStencil.FileSystem, 0.1.0-preview.1"
                    
#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 MailStencil.FileSystem@0.1.0-preview.1
                    
#: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=MailStencil.FileSystem&version=0.1.0-preview.1&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=MailStencil.FileSystem&version=0.1.0-preview.1&prerelease
                    
Install as a Cake Tool

MailStencil.FileSystem

An exact, read-only UTF-8 template reader. References MailStencil.Core only.

services.AddMailStencil().AddScribanRenderer().AddFileSystemTemplateReader(options =>
{
    options.BasePath = "./templates";
    // options.MaxTemplateFileSize = 128 * 1024; // default bytes per part, including BOM
});

Maps requests to <base>/<name>/<culture-or-default>/subject.txt, body.html, body.txt. Subject and at least one body must exist; empty files are allowed. No localization fallback or explicit versions are supported. Missing exact directories return null; malformed/unsafe/unstable content throws FileSystemTemplateException. Operational permission/I/O failures propagate.

The singleton has no mutable per-request shared state and performs async reads with bounded retries. Registration rejects existing readers. Symlinks/reparse points are rejected, including base ancestors. Use an application-controlled directory tree: portable metadata checks are not protection against every hostile filesystem race or a transactional multipart snapshot.

The provider accepts only restrictive logical name/culture segments and rejects links/reparse points. The configured base tree must still be controlled by the application: portable path checks are not an OS-handle-level sandbox and cannot guarantee a transactional snapshot against hostile writers.

See the MailStencil repository for the full runtime example, localization behavior, and security limits.

Product Compatible and additional computed target framework versions.
.NET 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
0.1.0-preview.1 0 9/10/2026

First public preview candidate of MailStencil's read-only runtime, renderer, and storage providers.