In this article, we are going to implement a sample in .NET6 Web API to send emails using the SendGrid Nuget Package.
Step3:
Let's register the 'From Emai Address', so let's complete the 'Create A Sender' form.
Let's install the SendGrid Dependency Injection library
Step 2:
Step 3:
Step 2:
Create A .Net6 Web API Project:
Let's create a .Net6 Web API sample application to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor.
CLI command
dotnet new webapi -o Your_Project_Name
dotnet new webapi -o Your_Project_Name
SendGrid:
SendGrid is a third-party email provider from which we can deal with 'send', and 'receive' operations of email to our application.
SendGrid SMTP(Simple Mail Transfer Protocol) provider for email transfer. SendGrid also provides SendGrid .Net NuGet package that provides easy configuration to any .NET applications. So to use the SendGrid SMTP we need 'Auth Key', 'From Email', so let's register into the SendGrid.
The following are the steps to register and generate the API key in SendGrid:
Step1:
Go to SendGrid's official website at 'https://sendgrid.com'. Next do SingUp.
Go to SendGrid's official website at 'https://sendgrid.com'. Next do SingUp.
Step2:
Now login in to the SendGrid website, then under the left-hand side menu go to 'Settings', then select 'Sender Authentication' menu. At 'Single Sender Verification' click on the 'GetStarted' button.
Let's register the 'From Emai Address', so let's complete the 'Create A Sender' form.
Step 4:
Our 'From Email Address need to be verified by clicking on the email we received from the SendGrid.
Step 5:
Under the 'Settings' menu select the 'API Keys' menu and then click on the 'Create API Key' button.
Step 6:
Choose permission level for an API key and then generate.
Step 7:
The API key generated is copied only once, so make sure to save it, later we are going to use it in our API.
Configure Email Settings In API:
Now settings like 'API Key', 'From Email', 'From Name' should be configured into 'appsettings.Development.json' file.
appsettings.Development.json:
"SendGridEmailSettings": { "APIKey": "", "FromEmail": "", "FromName": "" }
Install SendGrid NuGet Package:
Let's install the SendGrid NuGet package.
Package Manager
Install-Package SendGrid -Version 9.27.0
Install-Package SendGrid -Version 9.27.0
.NET CLI
dotnet add package SendGrid --version 9.27.0
dotnet add package SendGrid --version 9.27.0
Package Manager
Install-Package SendGrid.Extensions.DependencyInjection -Version 1.0.1
Install-Package SendGrid.Extensions.DependencyInjection -Version 1.0.1
.NET CLI
dotnet add package SendGrid.Extensions.DependencyInjection --version 1.0.1
dotnet add package SendGrid.Extensions.DependencyInjection --version 1.0.1
Register SendGrid Service:
Let's register the SendGrid service into the 'Program.cs' file.
Program.cs:
using SendGrid.Extensions.DependencyInjection; builder.Services.AddSendGrid(options => { options.ApiKey = builder.Configuration .GetSection("SendGridEmailSettings").GetValue<string>("APIKey"); });
- Configure the 'ApiKey' on registering the 'AddSendGrid' service.
Create A EmailController:
Let's create a new API controller like 'EmailController'.
Controllers/EmailController.cs:
using Microsoft.AspNetCore.Mvc; using SendGrid; namespace Dot6.SendgridMail.Controllers; [ApiController] [Route("[controller]")] public class EmailController : ControllerBase { private readonly ISendGridClient _sendGridClient; private readonly IConfiguration _configuration; public EmailController( ISendGridClient sendGridClient, IConfiguration configuration) { _sendGridClient = sendGridClient; _configuration = configuration; } }
- Injected the 'SendGrid.ISendGridClient', 'IConfiguration' into our 'EmailController'.
Sending Plain Text Email:
Let's implement an action method that sends a simple plain text as an email.
Controllers/EmailController.cs:
[HttpGet] [Route("send-text-mail")] public async Task<IActionResult> SendPlainTextEmail(string toEmail) { string fromEmail = _configuration.GetSection("SendGridEmailSettings") .GetValue<string>("FromEmail"); string fromName = _configuration.GetSection("SendGridEmailSettings") .GetValue<string>("FromName"); var msg = new SendGridMessage() { From = new EmailAddress(fromEmail, fromName), Subject = "Plain Text Email", PlainTextContent = "Hello, WellCome!!!" }; msg.AddTo(toEmail); var response = await _sendGridClient.SendEmailAsync(msg); string message = response.IsSuccessStatusCode ? "Email Send Successfully" : "Email Sending Failed"; return Ok(message); }
- (Line: 3) The 'To EmailAddress' is input parameter to our action method.
- (Line: 5-9) Fetching 'From Email Address', 'From Name' from the json settings.
- (Line: 11-16) Initialized 'SendGrid.Helpers.Mail.SendGridMessage' object here we can declare 'From Address', 'Email Subject', 'Email Plain Text Body'.
- (Line: 17) Adding To email address.
- (Line: 18) Send the email.
Sending HTML Template Email:
One of the most common emails is HTML template emails. Using HTML, and CSS styles we can create different styles of email templates. So to use an HTML email template email body must contains the 'head', 'body' HTML element. It also supports the CSS <style> tags.
Let's create a model like 'SuperHeroEmail'.
Models/SuperHeroEmail.cs:
namespace Dot6.SendgridMail.Models; public class SuperHeroEmail { public string Name { get; set; } public string ToEmail { get; set; } }
- Here 'Name' will be our superhero name for a demo, which we are going to bind to our email HTML.
- The 'ToEmail' will be the email address that going to receive the email.
Controllers/EmailController.cs:
private string EmailHTMLTemplate(SuperHeroEmail hero) { return @"<html><head> <meta charset='utf-8' /> <title></title> <style> @mixin media() { @media (min-width: 768px) { @content; } } body, html { font-family: 'Vollkorn', serif; font-weight: 400; line-height: 1.3; font-size: 16px; } .siteTitle { display: block; font-weight: 900; font-size: 30px; margin: 20px 0; @include media { font-size: 60px; } } header, main, footer { max-width: 960px; margin: 0 auto; } .card { height: 400px; position: relative; padding: 20px; box-sizing: border-box; display: flex; align-items: flex-end; text-decoration: none; border: 4px solid #b0215e; margin-bottom: 20px; background-image: url('https://baylorlariat.com/wp-content/uploads/2018/02/Iron-Man-Movie_Poster_2008.jpg'); background-size: cover; @include media { height: 500px; } } .inner { height: 50%; display: flex; flex-direction: column; justify-content: center; align-items: center; background: white; box-sizing: border-box; padding: 40px; @include media { width: 50%; height: 100%; } } .title { font-size: 24px; color: black; text-align: center; font-weight: 700; color: #181818; text-shadow: 0px 2px 2px #a6f8d5; position: relative; margin: 0 0 20px 0; @include media { font-size: 30px; } } </style> </head> <body> <div class='card'> <div class='inner'> <h2 class='title'>{{name}}</h2> <time class='subtitle'>Supper<time> </div> </div> </body> </html>".Replace("{{name}}", hero.Name); }
- Here we can observe the HML email template with in-line style tags.
- (Line: 96) Dynamically replacing the data in email.
Controllers/EmailController.cs:
[HttpPost] [Route("send-html-mail")] public async Task<IActionResult> SendHtmlEmail(SuperHeroEmail heroEmail) { string fromEmail = _configuration.GetSection("SendGridEmailSettings") .GetValue<string>("FromEmail"); string fromName = _configuration.GetSection("SendGridEmailSettings") .GetValue<string>("FromName"); var msg = new SendGridMessage() { From = new EmailAddress(fromEmail, fromName), Subject = "HTML Email", HtmlContent = EmailHTMLTemplate(heroEmail) }; msg.AddTo(heroEmail.ToEmail); var response = await _sendGridClient.SendEmailAsync(msg); string message = response.IsSuccessStatusCode ? "Email Send Successfully" : "Email Sending Failed"; return Ok(message); }
- (Line: 3) Action method inputs 'SuperHeroEmail' model
- (Line: 15) Email HTML template need to be assigned to 'HtmlContent' property of 'SendGridMessage' object.
Step3:
Sending Email With File Attachment:
Let's try to send an email with a file attachment using our SendGrid.
Let's create a new model like 'EmailFileAttchment'.
Models/EmailFileAttachment:
namespace Dot6.SendgridMail.Models; public class EmailFileAttachment { public IFormFile ImageFile { get; set; } public string ToEmail { get; set; } }
- (Line: 5) The 'IFormFile' default type captures the files that will be uploaded by the user.
- (Line: 6) The 'Email Address' to which our API sends email.
Controllers/EmailController.cs:
[HttpPost] [Route("send-mail-with-file-attachement")] public async Task<IActionResult> SendEmailFileAttchement([FromForm]EmailFileAttachment emailFile) { string fromEmail = _configuration.GetSection("SendGridEmailSettings") .GetValue<string>("FromEmail"); string fromName = _configuration.GetSection("SendGridEmailSettings") .GetValue<string>("FromName"); var msg = new SendGridMessage() { From = new EmailAddress(fromEmail, fromName), Subject = "File Attachement Email", PlainTextContent = "Check Attached File", }; await msg.AddAttachmentAsync( emailFile.ImageFile.FileName, emailFile.ImageFile.OpenReadStream(), emailFile.ImageFile.ContentType, "attachment" ); msg.AddTo(emailFile.ToEmail); var response = await _sendGridClient.SendEmailAsync(msg); string message = response.IsSuccessStatusCode ? "Email Send Successfully" : "Email Sending Failed"; return Ok(message); }
- (Line: 3) The 'FromForm' attribute needs to be prefixed by our input object type whenever we deal with the file content.
- (Line: 19-24) The 'AddAttachmentAsync' method to add a single file as an attachment to our email. To this method, we will pass our file information like 'file name', 'file content as stream', 'file type', 'disposition'. To attach multiple files we need to use 'AddAttachmentsAsync()' method that takes a collection of 'SendGrid.Helpers.Mail.Attachment' type.
Step 2:
Support Me!
Buy Me A Coffee
PayPal Me
Video Session:
Wrapping Up:
Hopefully, I think this article delivered some useful demo on .NET6 API sending emails using SendGrid NuGet Package. using I love to have your feedback, suggestions, and better techniques in the comment section below.
Comments
Post a Comment