SplatDev.Messaging 1.1.0

SplatDev.Messaging

Core messaging abstractions for the SplatDev Umbraco Plugins ecosystem. Provides contracts for email sending (single and bulk), SMS messaging, and canned/template-based message generation with placeholder replacement.

Compatibility

Installation

dotnet add package SplatDev.Messaging

Interfaces

IMessagingController<TMessage, TResult>

Core email sending contract with sync and async overloads:

public interface IMessagingController<TMessage, TResult>
{
    TResult SendMessage(string subject, string from, string fromAddress,
        string to, string toAddress, string message, string? plainMessage = null);

    TResult SendMessage(string subject, string from, string fromAddress,
        string to, string toAddress, string message, string? plainMessage,
        string? cc, string? bcc);

    TResult SendMessage(IAddress from, IAddress to, string subject,
        string message, string? plainMessage = null);

    TResult SendMessage(IAddress from, IAddress to, string subject,
        string message, string? plainMessage, IBulkAddress? cc, IBulkAddress? bcc);

    Task<TResult> SendMessageAsync(...);
    TResult SendMessage(TMessage message);
    Task<TResult> SendMessageAsync(TMessage message);
}

IBulkMessagingController<TMessage, TResult>

Bulk email sending with multiple recipients:

public interface IBulkMessagingController<TMessage, TResult>
{
    IEnumerable<TResult> SendMessage(IAddress from, string subject,
        string message, string? plainMessage, IEnumerable<IAddress> to);

    Task<IEnumerable<TResult>> SendMessageAsync(...);
}

ISmsService

SMS sending contract:

public interface ISmsService
{
    Task<SmsSendResult> SendSmsAsync(string to, string message);
}

Canned Message Templates

The library includes a template system for generating messages with placeholder replacement:

// Define placeholders
var placeholders = DefaultPlaceholders.Get(new Dictionary<string, string>
{
    { "name", "John" },
    { "email", "john@example.com" }
});

// Generate message from template
var message = CannedMessageHelpers.GenerateMessageFromTemplate(
    "Hello ##NAME##, welcome to ##SITENAME##", placeholders);

Built-in placeholders

Provider Implementations

Dependencies

None. This package has zero NuGet dependencies — it defines pure abstractions and interfaces.

SplatDev.Messaging — part of the SplatDev.Umbraco.Plugins suite. Licensed under MIT. © SplatDev Ltda.

Changelog

1.1.0 — 2026-08-25

Adds the two contracts the SMS providers now share. ISmsMessagingController<TMessage, TResult> declares synchronous and async SendMessage, both taking either a message object or a plain (from, to, body) triple, and Sms is a provider-neutral message with string addresses. Calling code can now depend on this package instead of on a particular provider. Additive only — nothing existing changed.

1.0.2 — 2026-08-24

Removes a dashboard screenshot that showed an error toast. It was captured against a site where this plugin's API was unreachable, so it advertised a broken dashboard. No screenshot is better than a misleading one; a replacement will be taken against a working install.

1.0.1 — 2026-08-24

Package metadata only: the listing now carries an icon and search tags, and the project and repository links point at the organisation that actually hosts this code. No code changes.

1.0.0 — 2026-08-24

This package now keeps a changelog. Earlier releases predate it and are not reconstructed here — consult the repository history for those. From this version on, every release records what changed for someone using it.