Transmitly.ChannelProvider.SendGrid 0.2.3

Transmitly.ChannelProvider.SendGrid

A Transmitly channel provider that enables sending Email communications with SendGrid

Getting started

To use the SendGrid channel provider, first install the NuGet package:

dotnet add package Transmitly.ChannelProvider.SendGrid

Then add the channel provider using AddSendGridSupport():

using Transmitly;
...
var communicationClient =
	new CommunicationsClientBuilder()
	.AddSendGridSupport(options =>
	{
		options.ApiKey = "12354";
	})
	.AddPipeline("first-pipeline", options =>
	{
		options.AddEmail("from@transmit.ly", email =>
		{
			email.Subject.AddStringTemplate("My first pipeline!");
			email.HtmlBody.AddStringTemplate("My <strong>first</strong> pipeline is great!");
			email.TextBody.AddStringTemplate("My *first* pipeline is great!");
		});
	});

• See the Transmitly project for more details on what a channel provider is and how it can be configured.

Using Templates

using Transmitly;
...
var communicationClient =
	new CommunicationsClientBuilder()
	.AddSendGridSupport(options =>
	{
		options.ApiKey = "12354";
	})
	.AddPipeline("first-pipeline", options =>
	{
		options.AddEmail("from@transmit.ly", email =>
		{
			//It's recommended to define 'backup' templates to keep
			//you prepared for using a different channel provider
			email.Subject.AddStringTemplate("My first pipeline!");
			email.HtmlBody.AddStringTemplate("My <strong>first</strong> pipeline is great!");
			email.TextBody.AddStringTemplate("My *first* pipeline is great!");

			email.SendGrid().TemplateId = "d-36ed2a324e76475f9c68462505899384";
		});
	});

Delivery Reports

SendGrid only allows one webhook per account and it's unable to be specified dynamically on a per communication basis. By using the MS MVC Core package we can take advantage of Transmitly's provider agnostic approach for handling delivery updates from the supported channel providers.

Setup

• SendGrid Dashboard

• Settings

• Mail Settings

• Webhook Settings

• Event Webhooks

• Create a new webhook

• Post Url: https://my.domain.com/Communications/channel/provider/update?tlyc=Email&tlycp=SendGrid

  • The path will depend upon your app. In this example, we're using the path to the Kitchen sink sample controller. The important bits are the ?tlyc=Email&tlycp=SendGrid to help out Transmitly.

• Your App

• dotnet add package Transmitly.Microsoft.AspnetCore.Mvc
  

• Register

  builder.Services
	.AddControllers(options =>
	{
		//Adds the necessary model binders to handle channel provider specific webhooks (Twilio, Infobip, etc)
		//and convert them to delivery reports (Added with package: Transmitly.Microsoft.AspnetCore.Mvc)
		options.AddTransmitlyDeliveryReportModelBinders();
	})
  	.AddTransmitly(tly=>
	{
		tly..AddDeliveryReportHandler((report) =>
		{
			logger?.LogInformation("[{channelId}:{channelProviderId}:StatusChanged] Id={id}; Status={status}", report.ChannelId, report.ChannelProviderId, report.ResourceId, report.Status.Type);
			return Task.CompletedTask;
		}, [DeliveryReport.Event.StatusChanged()])
  	   	//...rest of config
  	});

• Add a new controller route to handle the SendGrid webhooks

[HttpPost("channel/provider/update", Name = "DeliveryReport")]
public IActionResult ChannelProviderDeliveryReport(ChannelProviderDeliveryReportRequest providerReport)
{
	_communicationsClient.DispatchAsync(providerReport.DeliveryReports);
	return Ok();
}

<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="350" align="right"> </picture>

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