Transmitly 0.1.0-214.756c33c

This is a prerelease version of Transmitly.
There is a newer version of this package available.
See the version list below for details.
dotnet add package Transmitly --version 0.1.0-214.756c33c                
NuGet\Install-Package Transmitly -Version 0.1.0-214.756c33c                
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="Transmitly" Version="0.1.0-214.756c33c" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Transmitly --version 0.1.0-214.756c33c                
#r "nuget: Transmitly, 0.1.0-214.756c33c"                
#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.
// Install Transmitly as a Cake Addin
#addin nuget:?package=Transmitly&version=0.1.0-214.756c33c&prerelease

// Install Transmitly as a Cake Tool
#tool nuget:?package=Transmitly&version=0.1.0-214.756c33c&prerelease                

Transactional Communications

Transmitly is a powerful and vendor-agnostic communication library designed to simplify and enhance the process of sending transactional messages across various platforms. With its easy-to-use API, developers can seamlessly integrate email, SMS, and other messaging services into their applications, ensuring reliable and efficient delivery of critical notifications. Built for flexibility and scalability, Transmitly supports multiple communication channels, allowing you to focus on building great applications while it handles the complexity of message transmission.

Kitchen Sink

Want to jump right into the code? Take a look at the "Kitchen Sink" Sample Project. The kitchen sink is all about showing off the features of how Transmitly can help you with your communications strategy.

Quick Start

Let's start off where most developers start, sending an email via an SMTP server. In Transmitly, an Email is what we refer to as a Channel. A channel is the medium of which your communication will be dispatched. Out of the box, Transmitly supports: Email, SMS, Voice, and Push.

Add the Transmitly Nuget package to your project

dotnet add package Transmitly

Choosing a channel provider

As mentioned above, we're going to dispatch our Email using an SMTP server. To make this happen in transmitly, you'll add the MailKit Channel Provider library to your project.

Channel Providers handle the details of how your channel communication will be delivered. You can think of a Channel Provider as a service like Twilio, Infobip, Firebase or in this case, an SMTP server.

dotnet add package Transmitly.ChannelProvider.MailKit

Setup a Pipeline

Now it's time to configure a pipeline. Pipelines will give us a lot of flexibility down the road. For now you can think of a pipeline as a way to configure which channels and channel providers are involved when you dispatch domain event. In other words, you typically start an application by sending a welcome email to a newly registered user. As your application grows, you may want to send an SMS or an Email depending on which address the user gave you at sign up. With Transmitly, it's managed in a single location and your domain/business logic is agnostic of which communications are sent and how.

using Transmitly;

ICommunicationsClient communicationsClient = new CommunicationsClientBuilder()
.AddMailKitSupport(options =>
{
  options.Host = "smtp.example.com";
  options.Port = 587;
  options.UseSsl = true;
  options.UserName = "MySMTPUsername";
  options.Password = "MyPassword";
})
.AddPipeline("WelcomeKit", pipeline =>
{
    pipeline.AddEmail("welcome@my.app".AsIdentityAddress("Welcome Committee"), email =>
    {
       email.Subject.AddStringTemplate("Thanks for creating an account!");
       email.HtmlBody.AddStringTemplate("Check out the <a href=\"https://my.app/getting-started\">Getting Started</a> section to see all the cool things you can do!");
       email.TextBody.AddStringTemplate("Check out the Getting Started (https://my.app/getting-started) section to see all the cool things you can do!");
    });
.BuildClient();

//In this case, we're using Microsoft.DependencyInjection. We need to register our `ICommunicationsClient` with the service collection
//Tip: The Microsoft Dependency Injection library will take care of the registration for you (https://github.com/dotnet/runtime/tree/main/src/libraries/Microsoft.Extensions.DependencyInjection)
builder.Services.AddSingleton(communicationsClient);

In our new account registration code:

class AccountRegistrationService
{
  private readonly ICommunicationsClient _communicationsClient;
  public AccountRegistrationService(ICommunicationsClient communicationsClient)
  {
    _communicationsClient = communicationsClient;
  }

  public async Task<Account> RegisterNewAccount(AccountVM account)
  {
    //Validate and create the Account
    var newAccount = CreateAccount(account);

    //Dispatch (Send) our configured email
    var result = await _communicationsClient.DispatchAsync("WelcomeKit", "newAccount@gmail.com", new{});

    if(result.IsSuccessful)
      return newAccount;

    throw Exception("Error sending communication!");
  }
}

That's it! You're sending emails like a champ. But you might think that seems like a lot of work compared to a simple IEmail Client. Let's break down what we gained by using Transmitly.

  • Vendor agnostic - We can change channel providers with a simple configuration change
    • That means when we want to try out SendGrid, Twilio, Infobip or one of the many other services, it's a single change in a single location. ☺️
  • Delivery configuration - The details of our (Email) communications are not cluttering up our code base.
  • Message composition - The details of how an email or sms is generated are not scattered throughout your codebase.
    • In the future we may want to send an SMS and/or push notifications. We can now control that in a single location -- not in our business logic.
  • We can now use a single service/client for all of our communication needs
    • No more cluttering up your service constructors with IEmailClient, ISmsClient, etc.

Changing Channel Providers

Want to try out a new service to send out your emails? Twilio? Infobip? With Transmitly it's as easy as adding a your prefered channel provider and a few lines of configuration. In the example below, we'll try out SendGrid.

For the next example we'll start using SendGrid to send our emails.

dotnet install Transmitly.ChannelProvider.Sendgrid

Next we'll update our configuration. Notice we've removed MailKitSupport and added SendGridSupport.

using Transmitly;

ICommunicationsClient communicationsClient = new CommunicationsClientBuilder()
//.AddMailKitSupport(options =>
//{
//  options.Host = "smtp.example.com";
//  options.Port = 587;
//  options.UseSsl = true;
//  options.UserName = "MySMTPUsername";
//  options.Password = "MyPassword";
//})
.AddSendGridSupport(options=>
{
    options.ApiKey = "MySendGridApi";
})
.AddPipeline("WelcomeKit", pipeline =>
{
    pipeline.AddEmail("welcome@my.app".AsIdentityAddress("Welcome Committee"), email =>
    {
       email.Subject.AddStringTemplate("Thanks for creating an account!");
       email.HtmlBody.AddStringTemplate("Check out the <a href=\"https://my.app/getting-started\">Getting Started</a> section to see all the cool things you can do!");
       email.TextBody.AddStringTemplate("Check out the Getting Started (https://my.app/getting-started) section to see all the cool things you can do!");
    });
.BuildClient();

builder.Services.AddSingleton(communicationsClient);

That's right, we added a new channel provider package. Removed our SMTP/MailKit configuration and added and configured our Send Grid support. Notice that no other code needs to change. Our piplines, channel and more importantly our domain/business logic stays the same. 😮

Next Steps

We've only scratched the surface. Transmitly can do a LOT more to deliver more value for your entire team. Check out the Kitchen Sink sample to learn more about Transmitly's concepts while we work on improving our wiki.

Supported Channel Providers

Channel(s) Project
Email Transmitly.ChannelProvider.MailKit
Email Transmitly.ChannelProvider.SendGrid
Email, Sms, Voice Transmitly.ChannelProvider.InfoBip
Sms, Voice Transmitly.ChannelProvider.Twilio
Push Notifications Transmitly.ChannelProvider.Firebase

Supported Template Engines

Project
Transmitly.TemplateEngine.Fluid
Transmitly.TemplateEngine.Scriban

Supported Dependency Injection Containers

Container Project
Microsoft.Microsoft.Extensions.DependencyInjection Transmitly.Microsoft.Extensions.DependencyInjection

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/transmitly/transmitly/assets/3877248/524f26c8-f670-4dfa-be78-badda0f48bfb"> <img alt="an open-source project sponsored by CiLabs of Code Impressions, LLC" src="https://github.com/transmitly/transmitly/assets/3877248/34239edd-234d-4bee-9352-49d781716364" width="500" align="right"> </picture>


Copyright © Code Impressions, LLC - Provided under the Apache License, Version 2.0.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 is compatible.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETFramework 4.7.2

    • No dependencies.
  • .NETFramework 4.8

    • No dependencies.
  • .NETStandard 2.0

    • No dependencies.
  • net6.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (10)

Showing the top 5 NuGet packages that depend on Transmitly:

Package Downloads
Transmitly.ChannelProvider.Infobip

An Infobip channel provider for the Transmitly library.

Transmitly.ChannelProvider.Twilio

A channel provider for the Transmitly communications library.

Transmitly.Microsoft.Extensions.DependencyInjection

A Microsoft dependency injection extension for the Transmitly library.

Transmitly.ChannelProvider.MailKit

A channel provider for the Transmitly communications library.

Transmitly.TemplateEngine.Scriban

A template engine for the Transmitly communications library.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.0 405 9/9/2024
0.1.0-214.756c33c 48 10/20/2024
0.1.0-211.ec126bc 70 10/19/2024
0.1.0-178.b9d08f6 69 6/20/2024
0.1.0-176.e95bbdf 85 6/1/2024
0.1.0-175.f6ebc70 84 5/5/2024
0.1.0-175.95a6680 57 5/18/2024
0.1.0-174.b43bdf8 58 5/6/2024
0.1.0-172.6554ea1 74 4/19/2024
0.1.0-171.c8a05e5 60 4/18/2024
0.1.0-170.26f9ed7 62 4/17/2024
0.1.0-169.5907c88 73 4/9/2024
0.1.0-166.2e0b03d 56 4/8/2024
0.1.0-165.90903b5 57 4/8/2024
0.1.0-163.dcb9cdd 70 4/7/2024
0.1.0-161.17a01dc 71 4/5/2024
0.1.0-160.63d220a 52 4/5/2024
0.1.0-159.0921c83 59 4/5/2024
0.1.0-157.44ba356 81 4/3/2024
0.1.0-156.e0524a0 68 4/2/2024
0.1.0-154.2e35b69 70 3/31/2024
0.1.0-151.a4cb41f 68 3/31/2024
0.1.0-150.401c1e4 65 3/31/2024
0.1.0-149.8bd19ec 80 3/31/2024
0.1.0-148.5f12bd9 64 3/30/2024
0.1.0-147.abb66a4 59 3/30/2024
0.1.0-145.a57ff3a 91 3/23/2024
0.1.0-144.40348bf 59 3/23/2024
0.1.0-143.3ea52b9 70 3/22/2024
0.1.0-141.c74f31e 63 3/22/2024
0.1.0-140.caccefb 59 3/22/2024
0.1.0-139.abb6154 63 3/22/2024
0.1.0-136.9386ba7 76 3/21/2024
0.1.0-134.5ce017f 67 3/20/2024
0.1.0-133.7c4f2af 65 3/20/2024
0.1.0-132.8256df2 80 3/19/2024
0.1.0-129.e7bcd45 67 3/19/2024
0.1.0-127.618e95c 90 3/18/2024
0.1.0-126.13fde3a 68 3/18/2024
0.1.0-125.eaa0dc0 66 3/17/2024
0.1.0-124.1ef24bc 81 3/17/2024
0.1.0-122.1a1021f 76 3/15/2024
0.1.0-121.43cea6f 61 3/14/2024
0.1.0-113.de07dfa 109 3/13/2024