Skip to content

README.md

Latest commit

 

History

History
49 lines (34 loc) · 1.86 KB

README.md

File metadata and controls

49 lines (34 loc) · 1.86 KB
Raw

Transmitly.ChannelProvider.SendGrid.Sdk

SendGrid SDK-based email dispatcher implementation for Transmitly.

Recommended Package

Most users should use the convenience package instead:

That package registers this SDK implementation for you.

What This Package Provides

  • EmailChannelProviderDispatcher for the Email channel.
  • ExtendedEmailChannelProperties for SendGrid-specific email settings.
  • SendGridChannelProviderDeliveryReportRequestAdaptor for SendGrid event webhooks.
  • Concrete delivery-report property types for SendGrid webhook payload data.

Using This Package Directly (Advanced)

using Transmitly;
using Transmitly.ChannelProvider.SendGrid.Configuration;
using Transmitly.ChannelProvider.SendGrid.Sdk.Email;

var builder = new CommunicationsClientBuilder();

var options = new SendGridOptions
{
	ApiKey = "your-sendgrid-api-key"
};

builder.ChannelProvider
	.Build(Id.ChannelProvider.SendGrid(), options)
	.AddDispatcher<EmailChannelProviderDispatcher, IEmail>(Id.Channel.Email())
	.AddEmailExtendedPropertiesAdaptor<ExtendedEmailChannelProperties>()
	.AddDeliveryReportRequestAdaptor<SendGridChannelProviderDeliveryReportRequestAdaptor>()
	.Register();

Related Packages

Copyright (c) Code Impressions, LLC. This open-source project is sponsored and maintained by Code Impressions and is licensed under the Apache License, Version 2.0.