Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sendgrid/sendgrid-csharp
The Official Twilio SendGrid C#, .NetStandard, .NetCore API Library
https://github.com/sendgrid/sendgrid-csharp
c-sharp dotnet dotnet-core dotnet-standard dotnetcore email sendgrid transactional-emails
Last synced: about 1 month ago
JSON representation
The Official Twilio SendGrid C#, .NetStandard, .NetCore API Library
- Host: GitHub
- URL: https://github.com/sendgrid/sendgrid-csharp
- Owner: sendgrid
- License: mit
- Created: 2012-01-06T01:07:24.000Z (almost 13 years ago)
- Default Branch: main
- Last Pushed: 2024-07-23T13:08:50.000Z (4 months ago)
- Last Synced: 2024-10-04T17:18:29.295Z (about 1 month ago)
- Topics: c-sharp, dotnet, dotnet-core, dotnet-standard, dotnetcore, email, sendgrid, transactional-emails
- Language: C#
- Homepage: https://sendgrid.com
- Size: 9.72 MB
- Stars: 1,078
- Watchers: 267
- Forks: 584
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-Nuget-Packages - **Sendgrid**
README
[](https://github.com/sendgrid/sendgrid-csharp/actions/workflows/test-and-deploy.yml)
[](https://www.nuget.org/packages/SendGrid)
[](LICENSE)
[](https://twitter.com/sendgrid)
[](https://github.com/sendgrid/sendgrid-csharp/graphs/contributors)
[](https://www.codetriage.com/sendgrid/sendgrid-csharp)
# Announcements
* Send SMS messages with [Twilio](USE_CASES.md#sms).
# Overview
**This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via C# with .NET.**
Version 9.X.X+ of this library provides full support for all Twilio SendGrid [Web API v3](https://sendgrid.com/docs/API_Reference/api_v3.html) endpoints, including the new [v3 /mail/send](https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint).
For updates to this library, see our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases).
We appreciate your continued support, thank you!
# Table of Contents
* [Installation](#installation)
* [Prerequisites](#prerequisites)
* [Obtain an API Key](#obtain-api)
* [Setup Environment Variables to Manage Your API Key](#setup)
* [Install Package](#install-package)
* [Dependencies](#dependencies)
* [Quick Start](#quick-start)
* [Hello Email](#hello)
* [General v3 Web API Usage](#v3)
* [Web Proxy](#proxy)
* [Usage](#usage)
* [Use Cases](#use-cases)
* [Announcements](#announcements)
* [How to Contribute](#how-to-contribute)
* [Troubleshooting](#troubleshooting)
* [About](#about)
* [Support](#support)
* [License](#license)
# Installation
## Prerequisites
- .NET Framework 4.0+
- .NET Core 1.0+
- .NET Standard 1.3+
- A Twilio SendGrid account, [sign up for free](https://sendgrid.com/free?source=sendgrid-csharp) to send up to 40,000 emails for the first 30 days, then send 100 emails/day free forever or check out [our pricing](https://sendgrid.com/pricing?source=sendgrid-csharp).
Grab your API Key from the [Twilio SendGrid UI](https://app.sendgrid.com/settings/api_keys).
## Setup Environment Variables to Manage Your API Key
Manage your [Twilio SendGrid API Keys](https://app.sendgrid.com/settings/api_keys) by storing them in Environment Variables or in [Web.config](https://docs.microsoft.com/en-us/aspnet/identity/overview/features-api/best-practices-for-deploying-passwords-and-other-sensitive-data-to-aspnet-and-azure). It is a good practice to keep your data and configuration settings separate. This way you can change your Twilio SendGrid API key without changing your code. Also, we strongly advise against storing sensitive data directly in your code.
Setup Environment Variables using the UI:
1. Press Win+R and run SystemPropertiesAdvanced
2. Click on Environment Variables
3. Click New in user variables section
4. Type SENDGRID_API_KEY in the name. (Make sure this name matches the name of the key in your code)
5. Type actual API Key in the value
6. Restart the IDE and you're done!
Setup Environment Variables using CMD:
1. Run CMD as administrator
2. set SENDGRID_API_KEY="YOUR_API_KEY"
Here are a few examples to get and set API Keys programmatically:
```csharp
# Get Environment Variable
var apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
# Set Environment Variable
var setKey = Environment.SetEnvironmentVariable("SENDGRID_API_KEY", "YOUR_API_KEY");
```
## Install Package
To use Twilio SendGrid in your C# project, you can either download the Twilio SendGrid C# .NET libraries directly from our Github repository or if you have the NuGet package manager installed, you can grab them automatically:
```sh
dotnet add package SendGrid
# use Twilio SendGrid with HttpClientFactory
dotnet add package SendGrid.Extensions.DependencyInjection
```
Once you have the Twilio SendGrid library installed, you can include calls to it in your code.
For sample implementations, see the [.NET Core Example](ExampleCoreProject) and the [.NET 4.5.2 Example](ExampleNet45Project) folders.
## Dependencies
Please see the [.csproj file](src/SendGrid/SendGrid.csproj).
# Quick Start
The following is the minimum needed code to send a simple email. Use this example, and modify the `apiKey`, `from` and `to` variables:
```csharp
using System;
using System.Threading.Tasks;
using SendGrid;
using SendGrid.Helpers.Mail;
class Program
{
static async Task Main()
{
var apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
var client = new SendGridClient(apiKey);
var from = new EmailAddress("[email protected]", "Example User");
var subject = "Sending with Twilio SendGrid is Fun";
var to = new EmailAddress("[email protected]", "Example User");
var plainTextContent = "and easy to do anywhere, even with C#";
var htmlContent = "and easy to do anywhere, even with C#";
var msg = MailHelper.CreateSingleEmail(from, to, subject, plainTextContent, htmlContent);
var response = await client.SendEmailAsync(msg).ConfigureAwait(false);
}
}
```
After executing the above code, `response.StatusCode` should be `202` and you should have an email in the inbox of the `to` recipient. You can check the status of your email [in the UI](https://app.sendgrid.com/email_activity?). Alternatively, we can post events to a URL of your choice using our [Event Webhook](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook). This gives you data about the events that occur as Twilio SendGrid processes your email.
For more advanced cases, you can build the SendGridMessage object yourself with these minimum required settings:
```csharp
using System;
using System.Threading.Tasks;
using SendGrid;
using SendGrid.Helpers.Mail;
class Program
{
static async Task Main()
{
var apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
var client = new SendGridClient(apiKey);
var msg = new SendGridMessage()
{
From = new EmailAddress("[email protected]", "DX Team"),
Subject = "Sending with Twilio SendGrid is Fun",
PlainTextContent = "and easy to do anywhere, even with C#",
HtmlContent = "and easy to do anywhere, even with C#"
};
msg.AddTo(new EmailAddress("[email protected]", "Test User"));
var response = await client.SendEmailAsync(msg).ConfigureAwait(false);
}
}
```
You can find an example of all the email features [here](tests/SendGrid.Tests/Integration.cs#L79).
```csharp
using System;
using System.Threading.Tasks;
using SendGrid;
class Program
{
static async Task Main()
{
var apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
var client = new SendGridClient(apiKey);
var queryParams = @"{'limit': 100}";
var response = await client.RequestAsync(method: SendGridClient.Method.GET,urlPath: "suppression/bounces",
queryParams: queryParams).ConfigureAwait(false);
}
}
```
## HttpClientFactory + Microsoft.Extensions.DependencyInjection
> [SendGrid.Extensions.DependencyInjection](https://www.nuget.org/packages/SendGrid.Extensions.DependencyInjection) is required
```csharp
using System;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using SendGrid;
using SendGrid.Extensions.DependencyInjection;
using SendGrid.Helpers.Mail;
class Program
{
static async Task Main()
{
var services = ConfigureServices(new ServiceCollection()).BuildServiceProvider();
var client = services.GetRequiredService();
var msg = new SendGridMessage()
{
From = new EmailAddress("[email protected]", "Example User"),
Subject = "Sending with Twilio SendGrid is Fun"
};
msg.AddContent(MimeType.Text, "and easy to do anywhere, even with C#");
msg.AddTo(new EmailAddress("[email protected]", "Example User"));
var response = await client.SendEmailAsync(msg).ConfigureAwait(false);
}
private static IServiceCollection ConfigureServices(IServiceCollection services)
{
services.AddSendGrid(options =>
{
options.ApiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
});
return services;
}
}
```
```csharp
var apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
var proxy = new WebProxy("http://proxy:1337");
var client = new SendGridClient(proxy, apiKey);
```
Or when using DependencyInjection
```csharp
services.AddSendGrid(options =>
{
options.ApiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY");
})
.ConfigurePrimaryHttpMessageHandler(_ => new HttpClientHandler()
{
Proxy = new WebProxy(new Uri("http://proxy:1337")),
UseProxy = true
});
```
# Usage
- [Twilio SendGrid Docs](https://docs.sendgrid.com/api-reference/)
- [Library Usage Docs](USAGE.md)
- [Example Code - .NET Core](ExampleCoreProject)
- [Example Code - .NET 4.5.2+](ExampleNet45Project)
- [How-to: Migration from v2 to v3](https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html)
- [v3 Web API Mail Send Helper](src/SendGrid/Helpers/Mail)
# Use Cases
Here are some [examples of common API use cases](USE_CASES.md), such as how to send an email with a transactional template.
# How to Contribute
We encourage contribution to our library (you might even score some nifty swag), please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
Quick links:
- [Feature Request](CONTRIBUTING.md#feature-request)
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
- [Review Pull Requests](CONTRIBUTING.md#code-reviews)
# Troubleshooting
Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library issues.
# About
sendgrid-csharp is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-csharp are trademarks of Twilio SendGrid, Inc.
# Support
If you need help using SendGrid, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).
# License
[The MIT License (MIT)](LICENSE)