Home

Awesome

SendGrid Logo

Test and Deploy Twitter Follow GitHub contributors MIT licensed

This module helps build SendGrid's SMTP API headers.

Announcements

All updates to this module are documented in our CHANGELOG.

Table of Contents

<a name="installation"></a>

Installation

Prerequisites

Setup Environment Variables

Environment Variable

Update the development environment with your SENDGRID_API_KEY, for example:

  1. Make a copy of the .env_sample file and name it .env
  2. Edit the file changing only the value of SENDGRID_PASSWORD variable
  3. Save the file
  4. Add the .env file to your environment path

Install Package

To use SendGrid.SmtpApi in your C# project, you can either <a href="https://github.com/sendgrid/smtpapi-csharp.git">download the SendGrid C# .NET libraries directly from our Github repository</a> or, if you have the NuGet package manager installed, you can grab them automatically.

PM> Install-Package SendGrid.SmtpApi

Once you have the library properly referenced in your project, you can include calls to them in your code.

For a sample implementation, check the Example

<a name="quick-start"></a>

Quick Start

var header = new Header();

var uniqueArgs = new Dictionary<string,string> {
  { "foo", "bar" },
  { "chunky", "bacon"}
};

header.AddUniqueArgs(uniqueArgs);

var xmstpapiJson = header.JsonString();

You can then use the generated JSON in conjunction with your favorite SMTP library.

SmtpClient client = new SmtpClient();
client.Port = 587;
client.Host = "smtp.sendgrid.net";
client.Timeout = 10000;
client.DeliveryMethod = SmtpDeliveryMethod.Network;
client.UseDefaultCredentials = false;
client.Credentials = new System.Net.NetworkCredential("your_sendgrid_username","your_sendgrid_password");

MailMessage mail = new MailMessage();
mail.To.Add(new MailAddress("user@example.com"));
mail.From = new MailAddress("you@yourcompany.com");
mail.Subject = "this is a test email.";
mail.Body = "this is my test email body";

// add the custom header that we built above
mail.Headers.Add( "X-SMTPAPI", xmstpapiJson );

client.SendAsync(mail, null);

If you want to add multiple recipients to the X-SMTPAPI header for a mail merge type send, you can do something like the following:

var header = new Header();

var recipients = new List<String> {"test1@example.com", "test2@example.com", "test3@example.com"};
header.SetTo(recipients);

var subs = new List<String> {"A","B","C"};
header.AddSubstitution("%name%", subs);

var mail = new MailMessage
{
    From = new MailAddress("test@example.com"),
    Subject = "Welcome",
    Body = "Hi there %name%"
};

// add the custom header that we built above
mail.Headers.Add("X-SMTPAPI", header.JsonString());

<a name="usage"></a>

Usage

<a name="contribute"></a>

How to Contribute

We encourage contribution to our projects, please see our CONTRIBUTING guide for details.

Quick links:

<a name="about"></a>

About

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

<a name="support"></a>

Support

If you need help using SendGrid, please check the Twilio SendGrid Support Help Center.

<a name="license"></a>

License

The MIT License (MIT)