You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Subscribe to email [notifications](https://dx.sendgrid.com/newsletter/csharp) for releases and breaking changes.
14
14
* Send SMS messages with [Twilio](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md#sms).
@@ -30,17 +30,25 @@ We appreciate your continued support, thank you!
30
30
# Table of Contents
31
31
32
32
*[Installation](#installation)
33
+
*[Prerequisites](#prerequisites)
34
+
*[Obtain an API Key](#obtain-api)
35
+
*[Setup Environment Variables to Manage Your API Key](#setup)
36
+
*[Install Package](#install-package)
37
+
*[Dependencies](#dependencies)
33
38
*[Quick Start](#quick-start)
39
+
*[Hello Email](#hello)
40
+
*[General v3 Web API Usage](#v3)
41
+
*[Web Proxy](#proxy)
34
42
*[Usage](#usage)
35
43
*[Use Cases](#use-cases)
36
44
*[Announcements](#announcements)
37
45
*[Roadmap](#roadmap)
38
-
*[How to Contribute](#contribute)
46
+
*[How to Contribute](#how-to-contribute)
39
47
*[Troubleshooting](#troubleshooting)
40
48
*[About](#about)
41
49
*[License](#license)
42
50
43
-
# <aname="installation"></a>Installation
51
+
# Installation
44
52
45
53
## Prerequisites
46
54
@@ -49,10 +57,12 @@ We appreciate your continued support, thank you!
49
57
- .NET Standard 1.3 support
50
58
- 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).
51
59
60
+
<aname="obtain-api"></a>
52
61
## Obtain an API Key
53
62
54
63
Grab your API Key from the [Twilio SendGrid UI](https://app.sendgrid.com/settings/api_keys).
55
64
65
+
<aname="setup"></a>
56
66
## Setup Environment Variables to Manage Your API Key
57
67
58
68
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 to you can change your Twilio SendGrid API key without changing your code. Also, we strongly advise against storing sensitive data directly in your code.
@@ -71,7 +81,7 @@ Setup Environment Variables using CMD:
71
81
1. Run CMD as administrator
72
82
2. setx SENDGRID_API_KEY "YOUR_API_KEY"
73
83
74
-
Here are few example to get and set API Keys programmatically:
84
+
Here are a few examples to get and set API Keys programmatically:
75
85
76
86
```csharp
77
87
# Get Environment Variable
@@ -99,11 +109,12 @@ For sample implementations, see the [.NET Core Example](https://github.com/sendg
99
109
100
110
Please see the [.csproj file](https://github.com/sendgrid/sendgrid-csharp/blob/master/src/SendGrid/SendGrid.csproj).
101
111
102
-
# <aname="quick-start"></a>Quick Start
112
+
# Quick Start
103
113
114
+
<aname="hello"></a>
104
115
## Hello Email
105
116
106
-
The following is the minimum needed code to send an simple email. Use this example, and modify the `apiKey`, `from` and `to` variables:
117
+
The following is the minimum needed code to send a simple email. Use this example, and modify the `apiKey`, `from` and `to` variables:
107
118
108
119
```csharp
109
120
usingSystem;
@@ -157,8 +168,9 @@ class Program
157
168
}
158
169
```
159
170
160
-
You can find an example of all of the email features [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs#L79).
171
+
You can find an example of all the email features [here](https://github.com/sendgrid/sendgrid-csharp/blob/master/tests/SendGrid.Tests/Integration.cs#L79).
-[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)
237
250
-[v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-csharp/tree/master/src/SendGrid/Helpers/Mail)
238
251
239
-
# <aname="use-cases"></a>Use Cases
252
+
# Use Cases
240
253
241
254
Here are some [examples of common API use cases](https://github.com/sendgrid/sendgrid-csharp/blob/master/USE_CASES.md), such as how to send an email with a transactional template.
242
255
243
-
# <aname="roadmap"></a>Roadmap
256
+
# Roadmap
244
257
245
258
If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-csharp/issues) and [pull requests](https://github.com/sendgrid/sendgrid-csharp/pulls). We would love to hear your feedback!
246
259
247
-
# <aname="contribute"></a>How to Contribute
260
+
# How to Contribute
248
261
249
262
We encourage contribution to our library (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md) guide for details.
250
263
@@ -255,11 +268,11 @@ Quick links:
255
268
-[Improvements to the Codebase](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#improvements-to-the-codebase)
0 commit comments