Skip to main content

A Demo On .NET6 API Sending Email Using SendGrid NuGet Package

In this article, we are going to implement a sample in .NET6 Web API to send emails using the SendGrid Nuget Package.

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

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.

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. 

Step3:
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

.NET CLI
dotnet add package SendGrid --version 9.27.0

Let's install the SendGrid Dependency Injection library
Package Manager
Install-Package SendGrid.Extensions.DependencyInjection -Version 1.0.1

.NET CLI
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.
Step 1:

Step 2:

Step 3:

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.
Now let's define our email HTML template as follows.
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.
Let's create a new action method to send the HTML 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.
Step 1:

Step 2:

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.
Let's implement a new action method that will send an email with a file attachment.
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.
Step1:

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.

Follow Me:

Comments

Popular posts from this blog

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Blazor WebAssembly Custom Authentication From Scratch

In this article, we are going to explore and implement custom authentication from the scratch. In this sample, we will use JWT authentication for user authentication. Main Building Blocks Of Blazor WebAssembly Authentication: The core concepts of blazor webassembly authentication are: AuthenticationStateProvider Service AuthorizeView Component Task<AuthenticationState> Cascading Property CascadingAuthenticationState Component AuthorizeRouteView Component AuthenticationStateProvider Service - this provider holds the authentication information about the login user. The 'GetAuthenticationStateAsync()' method in the Authentication state provider returns user AuthenticationState. The 'NotifyAuthenticationStateChaged()' to notify the latest user information within the components which using this AuthenticationStateProvider. AuthorizeView Component - displays different content depending on the user authorization state. This component uses the AuthenticationStateProvider

How Response Caching Works In Asp.Net Core

What Is Response Caching?: Response Caching means storing of response output and using stored response until it's under it's the expiration time. Response Caching approach cuts down some requests to the server and also reduces some workload on the server. Response Caching Headers: Response Caching carried out by the few Http based headers information between client and server. Main Response Caching Headers are like below Cache-Control Pragma Vary Cache-Control Header: Cache-Control header is the main header type for the response caching. Cache-Control will be decorated with the following directives. public - this directive indicates any cache may store the response. private - this directive allows to store response with respect to a single user and can't be stored with shared cache stores. max-age - this directive represents a time to hold a response in the cache. no-cache - this directive represents no storing of response and always fetch the fr

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually

Usage Of CancellationToken In Asp.Net Core Applications

When To Use CancellationToken?: In a web application request abortion or orphan, requests are quite common. On users disconnected by network interruption or navigating between multiple pages before proper response or closing of the browser, tabs make the request aborted or orphan. An orphan request can't deliver a response to the client, but it will execute all steps(like database calls, HTTP calls, etc) at the server. Complete execution of an orphan request at the server might not be a problem generally if at all requests need to work on time taking a job at the server in those cases might be nice to terminate the execution immediately. So CancellationToken can be used to terminate a request execution at the server immediately once the request is aborted or orphan. Here we are going to see some sample code snippets about implementing a CancellationToken for Entity FrameworkCore, Dapper ORM, and HttpClient calls in Asp.NetCore MVC application. Note: The sample codes I will show in

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications 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. Create a fo

.Net5 Web API Managing Files Using Azure Blob Storage

In this article, we are going to understand the different file operations like uploading, reading, downloading, and deleting in .Net5 Web API application using Azure Blob Storage. Azure Blob Storage: Azure blob storage is Microsoft cloud storage. Blob storage can store a massive amount of file data as unstructured data. The unstructured data means not belong to any specific type, which means text or binary data. So something like images or pdf or videos to store in the cloud, then the most recommended is to use the blob store. The key component to creating azure blob storage resource: Storage Account:- A Storage account gives a unique namespace in Azure for all the data we will save. Every object that we store in Azure Storage has an address. The address is nothing but the unique name of our Storage Account name. The combination of the account name and the Azure Storage blob endpoint forms the base address for each object in our Storage account. For example, if our Storage Account is n

Different HttpClient Techniques To Consume API Calls In Minimal API[.NET6]

In this article, we are going to implement different HttpClient techniques to consume API calls in minimal API. The different HttpClient techniques that we are going to explore are like: Register HttpClient Object Explicitly In DI(Dependency Injection Service) Named Client Type Client HttpRequestMessage Object Create A .NET6 Minimal API Project: Let's create a .Net6 Minimal API sample project 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 For Minimal API Project dotnet new webapi -minimal -o Your_Project_Name Create A Third Party API Response Model: Here I'm going to use a free third-party rest API that is "https://jsonplaceholder.typicode.com/posts". So to receive the response let's create a response model like 'Post.cs'. Program.cs:(Add Post.cs c

.Net5 Web API Redis Cache Using StackExchange.Redis.Extensions.AspNetCore Library

In this article, we are going to explore the integration of Redis cache in .Net5 Web API application using the 'StackExchange.Redis.Exntensions' library. Note:- Microsoft has introduced an 'IDistributedCache' interface in dotnet core which supports different cache stores like In-Memory, Redis, NCache, etc. It is simple and easy to work with  'IDistributedCache', for the Redis store with limited features but if we want more features of the Redis store we can choose to use 'StackExchange.Redis.Extensions'.  Click here for Redis Cache Integration Using IDistributedCache Interface . Overview On StackExchange.Redis.Extnesions Library: The 'StackExchange.Redis.Extension' library extended from the main library 'StackExchange.Redis'. Some of the key features of this library like: Default serialization and deserialization. Easy to save and fetch complex objects. Search key. Multiple Database Access Setup Redis Docker Instance: For this sampl