MX.Platform.Notifications.Abstractions.V1
1.0.18
dotnet add package MX.Platform.Notifications.Abstractions.V1 --version 1.0.18
NuGet\Install-Package MX.Platform.Notifications.Abstractions.V1 -Version 1.0.18
<PackageReference Include="MX.Platform.Notifications.Abstractions.V1" Version="1.0.18" />
<PackageVersion Include="MX.Platform.Notifications.Abstractions.V1" Version="1.0.18" />
<PackageReference Include="MX.Platform.Notifications.Abstractions.V1" />
paket add MX.Platform.Notifications.Abstractions.V1 --version 1.0.18
#r "nuget: MX.Platform.Notifications.Abstractions.V1, 1.0.18"
#:package MX.Platform.Notifications.Abstractions.V1@1.0.18
#addin nuget:?package=MX.Platform.Notifications.Abstractions.V1&version=1.0.18
#tool nuget:?package=MX.Platform.Notifications.Abstractions.V1&version=1.0.18
MX.Platform.Notifications.Abstractions.V1
This package provides the abstraction layer (interfaces and models) for the Platform Notifications service.
Installation
dotnet add package MX.Platform.Notifications.Abstractions.V1
Key Types
| Type | Description |
|---|---|
INotificationsApiClient |
Unified client interface — entry point for all notification APIs |
ISendEmailApi |
Interface for sending emails via SendEmail(request) |
SendEmailRequestDto |
Email request — sender domain, recipients, subject, and body |
SendEmailResponseDto |
Email response — tracking ID and status (Queued) |
EmailRecipientDto |
Email recipient — address and optional display name |
Required vs Optional Fields
SendEmailRequestDto
| Field | Required | Default | Description |
|---|---|---|---|
SenderDomain |
✅ | — | Domain to send from (must be configured in ACS) |
Subject |
✅ | — | Email subject line |
To |
✅ | [] |
Primary recipients (at least one expected) |
SenderUsername |
— | "noreply" |
Local part of sender address |
SenderDisplayName |
— | null |
Display name for the sender |
HtmlBody |
— | null |
HTML body (provide at least one body) |
PlainTextBody |
— | null |
Plain-text body (provide at least one body) |
Cc |
— | null |
CC recipients |
Bcc |
— | null |
BCC recipients |
Usage
This package is typically consumed indirectly via the Api.Client.V1 package. If you only need the interfaces and models (e.g. for a shared contract library), reference this package directly:
using MX.Platform.Notifications.Abstractions.V1.Interfaces;
using MX.Platform.Notifications.Abstractions.V1.Models;
public class MyService(INotificationsApiClient notifications)
{
public async Task SendWelcomeEmail(string recipientEmail, string recipientName)
{
var request = new SendEmailRequestDto
{
SenderDomain = "contoso.com",
Subject = "Welcome!",
HtmlBody = "<h1>Welcome</h1><p>Thanks for signing up.</p>",
PlainTextBody = "Welcome! Thanks for signing up.",
To = [new EmailRecipientDto { EmailAddress = recipientEmail, DisplayName = recipientName }]
};
var result = await notifications.Email.SendEmail(request);
if (result.IsSuccess)
{
// result.Result.Data.MessageId — unique tracking ID
// result.Result.Data.Status — "Queued" (delivery happens asynchronously)
}
}
}
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. 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. |
-
net10.0
- MX.Api.Abstractions (>= 2.3.25)
- Newtonsoft.Json (>= 13.0.4)
-
net9.0
- MX.Api.Abstractions (>= 2.3.25)
- Newtonsoft.Json (>= 13.0.4)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on MX.Platform.Notifications.Abstractions.V1:
| Package | Downloads |
|---|---|
|
MX.Platform.Notifications.Api.Client.V1
This package provides a web service client for the Platform Notifications service. |
|
|
MX.Platform.Notifications.Api.Client.Testing
Test helpers for consumer apps: in-memory fakes of INotificationsApiClient, DTO factory methods, and DI extensions for integration tests. |
GitHub repositories
This package is not used by any popular GitHub repositories.