SplatDev.Umbraco.Plugins.Newsletters
2.0.1
dotnet add package SplatDev.Umbraco.Plugins.Newsletters --version 2.0.1
NuGet\Install-Package SplatDev.Umbraco.Plugins.Newsletters -Version 2.0.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="SplatDev.Umbraco.Plugins.Newsletters" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SplatDev.Umbraco.Plugins.Newsletters" Version="2.0.1" />
<PackageReference Include="SplatDev.Umbraco.Plugins.Newsletters" />
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 SplatDev.Umbraco.Plugins.Newsletters --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SplatDev.Umbraco.Plugins.Newsletters, 2.0.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 SplatDev.Umbraco.Plugins.Newsletters@2.0.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=SplatDev.Umbraco.Plugins.Newsletters&version=2.0.1
#tool nuget:?package=SplatDev.Umbraco.Plugins.Newsletters&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
UmbracoCms.Plugins.Newsletters
Newsletter subscriber management, campaigns, and send tracking for Umbraco 13 (net8.0) and Umbraco 17 (net10.0).
Features
- Subscriber management (subscribe / unsubscribe / confirmation flow)
- Campaign management (Draft, Scheduled, Sent states)
- Send tracking with open-rate recording
- Public subscription form via view component
- Backoffice dashboard (Lit 3 for U17, AngularJS for U13)
- Full REST API
View Component
Embed the subscribe form in any Razor view:
@await Component.InvokeAsync("NewsletterSubscribe")
@* With custom labels: *@
@await Component.InvokeAsync("NewsletterSubscribe", new {
buttonLabel = "Join Newsletter",
placeholderText = "your@email.com"
})
API Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /umbraco/api/newsletters/subscribe |
Subscribe an email |
| POST | /umbraco/api/newsletters/unsubscribe |
Unsubscribe an email |
| GET | /umbraco/api/newsletters/subscribers |
List active subscribers |
| GET | /umbraco/api/newsletters/campaigns |
List all campaigns |
| POST | /umbraco/api/newsletters/send |
Send a campaign |
| POST | /umbraco/api/newsletters/campaigns |
Create a campaign |
Database Tables
NewsletterSubscribers— subscriber records with confirmation and unsubscribe trackingNewsletterCampaigns— campaign content and statusNewsletterSends— per-subscriber send records with open tracking
Notes
The SendCampaignAsync method records send entries and marks the campaign as Sent.
Wire it up to an email delivery service (SendGrid, SMTP, Mailgun, etc.) in
NewslettersService.cs at the appropriate comment.
| Product | Versions 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 was computed. 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.
-
net10.0
- Microsoft.EntityFrameworkCore.Design (>= 10.0.7)
- Microsoft.EntityFrameworkCore.SqlServer (>= 10.0.7)
- Umbraco.Cms.Core (>= 17.3.4)
- Umbraco.Cms.Web.Common (>= 17.3.4)
-
net8.0
- Microsoft.EntityFrameworkCore.Design (>= 8.0.20)
- Microsoft.EntityFrameworkCore.SqlServer (>= 8.0.20)
- Umbraco.Cms.Core (>= 13.12.0)
- Umbraco.Cms.Web.Common (>= 13.12.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.