AspNetCore.Identity.Services.SendGrid
2.0.8
See the version list below for details.
dotnet add package AspNetCore.Identity.Services.SendGrid --version 2.0.8
NuGet\Install-Package AspNetCore.Identity.Services.SendGrid -Version 2.0.8
<PackageReference Include="AspNetCore.Identity.Services.SendGrid" Version="2.0.8" />
paket add AspNetCore.Identity.Services.SendGrid --version 2.0.8
#r "nuget: AspNetCore.Identity.Services.SendGrid, 2.0.8"
// Install AspNetCore.Identity.Services.SendGrid as a Cake Addin #addin nuget:?package=AspNetCore.Identity.Services.SendGrid&version=2.0.8 // Install AspNetCore.Identity.Services.SendGrid as a Cake Tool #tool nuget:?package=AspNetCore.Identity.Services.SendGrid&version=2.0.8
SendGrid IEmailSender for ASP.NET Core Identity
This is a .Net 6 SendGrid Email Sender for use with Asp.Net Core Identity. It installs as a service in your project's 'Program.cs' or 'Startup.cs' file.
Installation
To add this provider to your own Asp.Net 6 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 | Versions 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 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 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. |
-
net6.0
- Microsoft.AspNetCore.Identity.UI (>= 6.0.10)
- Microsoft.Extensions.DependencyInjection (>= 6.0.1)
- Microsoft.Extensions.Http (>= 6.0.0)
- SendGrid (>= 9.28.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Updated SendGrid NuGet pkg.