AspNetCore.Identity.Services.SendGrid 2.1.1

.NET 6.0 
dotnet add package AspNetCore.Identity.Services.SendGrid --version 2.1.1
NuGet\Install-Package AspNetCore.Identity.Services.SendGrid -Version 2.1.1
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="AspNetCore.Identity.Services.SendGrid" Version="2.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add AspNetCore.Identity.Services.SendGrid --version 2.1.1
#r "nuget: AspNetCore.Identity.Services.SendGrid, 2.1.1"
#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 AspNetCore.Identity.Services.SendGrid as a Cake Addin
#addin nuget:?package=AspNetCore.Identity.Services.SendGrid&version=2.1.1

// Install AspNetCore.Identity.Services.SendGrid as a Cake Tool
#tool nuget:?package=AspNetCore.Identity.Services.SendGrid&version=2.1.1

SendGrid IEmailSender for ASP.NET Core Identity

.NET Build

This is a SendGrid Email Sender for use with Asp.Net Core Identity (.Net 6 or .Net 7). It installs as a service in your project's 'Program.cs' or 'Startup.cs' file.

Feedback Welcome!

Please send us feedback regarding this package using our issues section of our project repository.

Installation

To add this provider to your own .Net 6 or .Net 7 web project, add the following NuGet package

PM> Install-Package AspNetCore.Identity.Services.SendGrid

Configure app to support email

Next add the following code to your startup file:

// Get SendGrid key
var sendGridApiKey = builder.Configuration.GetValue<string>("SendGridApiKey");
// In the following you're adding your SendGrid API key and the default "From" email address.
var sendGridOptions = new SendGridEmailProviderOptions(sendGridApiKey, "your@emailaddress.com");

// You can put the provider into "Sandbox mode" by adding the following:
sendGridOptions.SandboxMode = true;

// Add the configured service.
builder.Services.AddSendGridEmailProvider(sendGridOptions);

Debugging Email Problems

It is possible to debug email problems by using the Response property of the sender. This returns the SendGrid response object which indicates success or error. Here is example code:

var response = ((SendGridEmailSender) _emailSender).Response;

Sandbox Mode

Putting the provider into sandbox mode will allow you to validate interoperability with SendGrid while not actually sending any emails.

Logging Email Success and Errors

Often in production you may want the email provider to send errors and/or successful email sends to the ILogger. You can also cause the provider to throw exceptions when email send encounters errors.

Here is example code that show how to enable each option:

var options = new SendGridEmailProviderOptions(
    "SendGrid_API_Key", // Your SendGrid API Key,
    "foo@foo.com", // Your default 'from' email address
    false, // Sandbox mode true or false
    false, // Send successful sends to ILogger (true or false)
    true // Send errors sends to ILogger (true or false)
);

options.HttpErrorAsException = true; // Throw exceptions upon SendGrid errors

Bug Reports, Featue Requests, and Feedback

Please submit bug reports, feature requests or other feedback to our issues discussion.

Product Compatible and additional computed target framework versions.
.NET 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 is compatible.  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 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.1.1 3,210 1/30/2023
2.1.0 435 12/15/2022
2.0.8 1,631 10/27/2022
2.0.6 1,166 7/24/2022
2.0.5 424 7/12/2022
2.0.4 390 7/12/2022
2.0.3 404 7/5/2022
2.0.2.4 398 7/2/2022
2.0.2.3 375 7/2/2022
2.0.2.2 374 7/2/2022
2.0.2.1 377 7/2/2022
1.0.0 378 7/1/2022

Documentation dependencies updated.