C# JavaScript Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Update PULL_REQUEST_TEMPLATE Oct 28, 2017
ExampleCoreProject Added code comments regarding setting up environment variables Oct 2, 2017
ExampleNet45ASPNetProject Updated readme. Updated solution file to include new WebForms project. Oct 4, 2017
ExampleNet45Project Added code comments regarding setting up environment variables Oct 2, 2017
docker Add instructions to build container Oct 30, 2017
examples Important Typos. Jun 23, 2017
nuspec Version Bump v9.9.0: #509 Transient Fault Handling (dependency free) Aug 22, 2017
prism Fixed permissions Sep 20, 2016
src/SendGrid Merge pull request #522 from shortstuffsushi/update-add-attachment-in… Nov 28, 2017
tests/SendGrid.Tests Merge pull request #522 from shortstuffsushi/update-add-attachment-in… Nov 28, 2017
tools Adding /tools directory Dec 7, 2016
.env_sample remove export Oct 29, 2017
.gitignore Add a .env_sample file, update gitignore, update README.md Oct 27, 2017
.travis.yml README update Aug 29, 2017
CHANGELOG.md Spelling corrections in md, xml docs and variable names Oct 21, 2017
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md Oct 10, 2017
CONTRIBUTING.md Update CONTRIBUTING.md Aug 10, 2018
LICENSE.txt Updates the license file to have the correct date range: 2016-2017 Oct 28, 2017
README.md update readme tags Aug 7, 2018
SendGrid.sln Remove sample project with its own solution Jun 10, 2017
TROUBLESHOOTING.md Update TROUBLESHOOTING.md Oct 6, 2017
USAGE.md Update Create Template Version Docs as per sendgrid support request 'h… Feb 23, 2018
USE_CASES.md Update USE_CASES.md Aug 21, 2018

README.md

SendGrid Logo

BuildStatus NuGet Email Notifications Badge MIT licensed Twitter Follow GitHub contributors Open Source Helpers

Announcements

Subscribe to email notifications for releases and breaking changes.

Overview

This library allows you to quickly and easily use the SendGrid Web API v3 via C# with .NET.

Version 9.X.X+ of this library provides full support for all SendGrid Web API v3 endpoints, including the new v3 /mail/send.

We want this library to be community driven, and SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create issues and pull requests or simply upvote or comment on existing issues or pull requests.

For updates to this library, see our CHANGELOG and releases.

Subscribe to email release notifications to receive emails about releases and breaking changes.

We appreciate your continued support, thank you!

Table of Contents

Installation

Prerequisites

  • .NET version 4.5.2 and higher
  • .NET Core 1.0 and higher
  • .NET Standard 1.3 support
  • A SendGrid account, sign up for free to send up to 40,000 emails for the first 30 days or check out our pricing.

Obtain an API Key

Grab your API Key from the SendGrid UI.

Setup Environment Variables to Manage Your API Key

Manage your SendGrid API Keys by storing them in Environment Variables or in Web.config. It is a good practice to keep your data and configuration settings separate. This way to you can change your 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 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. setx SENDGRID_API_KEY "YOUR_API_KEY"

Here are few example to get and set API Keys programatically:

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 SendGrid in your C# project, you can either download the SendGrid C# .NET libraries directly from our Github repository or if you have the NuGet package manager installed, you can grab them automatically:

PM> Install-Package SendGrid

Once you have the SendGrid library installed, you can include calls to them in your code. For sample implementations, see the .NET Core Example and the .NET 4.5.2 Example folders.

Dependencies

Quick Start

Hello Email

The following is the minimum needed code to send an simple email. Use this example, and modify the apiKey, from and to variables:

using SendGrid;
using SendGrid.Helpers.Mail;
using System;
using System.Threading.Tasks;

namespace Example
{
    internal class Example
    {
        private static void Main()
        {
            Execute().Wait();
        }

        static async Task Execute()
        {
            var apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY");
            var client = new SendGridClient(apiKey);
            var from = new EmailAddress("test@example.com", "Example User");
            var subject = "Sending with SendGrid is Fun";
            var to = new EmailAddress("test@example.com", "Example User");
            var plainTextContent = "and easy to do anywhere, even with C#";
            var htmlContent = "<strong>and easy to do anywhere, even with C#</strong>";
            var msg = MailHelper.CreateSingleEmail(from, to, subject, plainTextContent, htmlContent);
            var response = await client.SendEmailAsync(msg);
        }
    }
}

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. Alternatively, we can post events to a URL of your choice using our Event Webhook. This gives you data about the events that occur as SendGrid processes your email.

For more advanced cases, you can build the SendGridMessage object yourself with these minimum required settings:

using SendGrid;
using SendGrid.Helpers.Mail;
using System;
using System.Threading.Tasks;

namespace Example
{
    internal class Example
    {
        private static void Main()
        {
            Execute().Wait();
        }

	    static async Task Execute()
        {
            var apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY");
            var client = new SendGridClient(apiKey);
            var msg = new SendGridMessage()
            {
                From = new EmailAddress("test@example.com", "DX Team"),
                Subject = "Sending with SendGrid is Fun",
                PlainTextContent = "and easy to do anywhere, even with C#",
                HtmlContent = "<strong>and easy to do anywhere, even with C#</strong>"
            };
            msg.AddTo(new EmailAddress("test@example.com", "Test User"));
            var response = await client.SendEmailAsync(msg);
        }
    }
}

You can find an example of all of the email features here.

General v3 Web API Usage

using System;
using System.Threading.Tasks;
using SendGrid;

namespace Example
{
    internal class Example
    {
        private static void Main()
        {
            Execute().Wait();
        }

        static async Task Execute()
        {
            var apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY");
            var client = new SendGridClient(apiKey);
            var queryParams = @"{
                'limit': 100
            }";
            var response = await client.RequestAsync(method: SendGridClient.Method.GET,
                                                     urlPath: "suppression/bounces",
                                                     queryParams: queryParams);
	    }
    }
}

Web Proxy

var apiKey = Environment.GetEnvironmentVariable("NAME_OF_THE_ENVIRONMENT_VARIABLE_FOR_YOUR_SENDGRID_KEY");
var proxy = new WebProxy("http://proxy:1337");
var client = new SendGridClient(proxy, apiKey);

Usage

Use Cases

Here are some examples of common API use cases, such as how to send an email with a transactional template.

Roadmap

If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback!

How to Contribute

We encourage contribution to our library (you might even score some nifty swag), please see our CONTRIBUTING guide for details.

Quick links:

Troubleshooting

Please see our troubleshooting guide for common library issues.

About

sendgrid-csharp is guided and supported by the SendGrid Developer Experience Team.

sendgrid-csharp is maintained and funded by SendGrid, Inc. The names and logos for sendgrid-csharp are trademarks of SendGrid, Inc.

License

The MIT License (MIT)