Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sendgrid/smtpapi-csharp
SendGrid's smtpapi library in C#
https://github.com/sendgrid/smtpapi-csharp
Last synced: 2 months ago
JSON representation
SendGrid's smtpapi library in C#
- Host: GitHub
- URL: https://github.com/sendgrid/smtpapi-csharp
- Owner: sendgrid
- License: mit
- Created: 2014-01-03T21:26:42.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2023-04-10T00:18:16.000Z (almost 2 years ago)
- Last Synced: 2024-08-03T03:04:21.541Z (5 months ago)
- Language: C#
- Homepage: https://sendgrid.com
- Size: 2.81 MB
- Stars: 27
- Watchers: 202
- Forks: 60
- Open Issues: 0
-
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.SmtpApi**
README
[](https://github.com/sendgrid/smtpapi-csharp/actions/workflows/test-and-deploy.yml)
[](https://twitter.com/sendgrid)
[](https://github.com/sendgrid/smtpapi-csharp/graphs/contributors)
[](LICENSE)
**This module helps build SendGrid's SMTP API headers.**
# Announcements
All updates to this module are documented in our [CHANGELOG](CHANGELOG.md).
# Table of Contents
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [How to Contribute](#contribute)
- [About](#about)
- [Support](#support)
- [License](#license)
## Prerequisites
- .NET Framework 4.0+
- [The SendGrid service](https://sendgrid.com/free?source=smtpapi-csharp)
## Setup Environment Variables
### Environment Variable
Update the development environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys), 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 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.
```bash
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](Smtpapi/Example/Program.cs)
```csharp
var header = new Header();
var uniqueArgs = new Dictionary {
{ "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.
```csharp
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("[email protected]"));
mail.From = new MailAddress("[email protected]");
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:
```csharp
var header = new Header();
var recipients = new List {"[email protected]", "[email protected]", "[email protected]"};
header.SetTo(recipients);
var subs = new List {"A","B","C"};
header.AddSubstitution("%name%", subs);
var mail = new MailMessage
{
From = new MailAddress("[email protected]"),
Subject = "Welcome",
Body = "Hi there %name%"
};
// add the custom header that we built above
mail.Headers.Add("X-SMTPAPI", header.JsonString());
```
- [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html)
- [Example Code](Smtpapi/Example/Program.cs)
We encourage contribution to our projects, please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details.
Quick links:
- [Feature Request](CONTRIBUTING.md)
- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report)
- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase)
smtpapi-csharp is maintained and funded by Twilio SendGrid, Inc. The names and logos for smtpapi-csharp are trademarks of Twilio SendGrid, Inc.
If you need help using SendGrid, please check the [Twilio SendGrid Support Help Center](https://support.sendgrid.com).