diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 59 |
1 files changed, 17 insertions, 42 deletions
@@ -1,18 +1,10 @@ -[](https://travis-ci.org/sendgrid/sendgrid-csharp) +[](https://travis-ci.org/sendgrid/sendgrid-csharp) **This library allows you to quickly and easily use the SendGrid Web API via C Sharp with .NET.** # Announcements -**NOTE: The `/mail/send/beta` endpoint is currently in beta! - -Since this is not a general release, we do not recommend POSTing production level traffic through this endpoint or integrating your production servers with this endpoint. - -When this endpoint is ready for general release, your code will require an update in order to use the official URI. - -By using this endpoint, you accept that you may encounter bugs and that the endpoint may be taken down for maintenance at any time. We cannot guarantee the continued availability of this beta endpoint. We hope that you like this new endpoint and we appreciate any [feedback](dx+mail-beta@sendgrid.com) that you can send our way.** - -**BREAKING CHANGE as of XXXX.XX.XX** +**BREAKING CHANGE as of 2016.06.14** Version `7.0.0` is a breaking change for the entire library. @@ -22,40 +14,23 @@ have the following resources to get you started quickly: - [SendGrid Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) - [Usage - Documentation](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/USAGE.md) + Documentation](https://github.com/sendgrid/sendgrid-csharp/tree/master/USAGE.md) - [Example - Code](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/Example) + Code](https://github.com/sendgrid/sendgrid-csharp/tree/master/Example) Thank you for your continued support! -All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-csharp/blob/v3beta/CHANGELOG.md). +All updates to this library is documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-csharp/blob/master/CHANGELOG.md). # Installation -## Environment Variables +## Setup Environment Variables First, get your free SendGrid account [here](https://sendgrid.com/free?source=sendgrid-csharp). Next, update your Environment (user space) with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys). -## TRYING OUT THE V3 BETA MAIL SEND - -* Check out the v3beta branch from `https://github.com/sendgrid/sendgrid-csharp.git` using your favorite Git client. -* Open the [solution](https://github.com/sendgrid/sendgrid-csharp/blob/v3beta/SendGrid/SendGrid.sln) in Visual Studio (we have tested with the Community Edition). -* Update the to and from [emails](https://github.com/sendgrid/sendgrid-csharp/blob/v3beta/SendGrid/Example/Example.cs#L26). -* Build the Solution. -* Build the Example project and click `Start`. -* Check out the documentation for [Web API v3 /mail/send/beta endpoint](https://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/index.html). - -## TRYING OUT THE V3 BETA WEB API - -* Check out the v3beta branch from `https://github.com/sendgrid/sendgrid-csharp.git` using your favorite Git client. -* Open the [solution](https://github.com/sendgrid/sendgrid-csharp/blob/v3beta/SendGrid/SendGrid.sln) in Visual Studio (we have tested with the Community Edition). -* Check out the documentation for [Web API v3 endpoints](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html). -* Review the corresponding [examples](https://github.com/sendgrid/sendgrid-csharp/blob/v3beta/examples). -* You can add your test code to our [Example project](https://github.com/sendgrid/sendgrid-csharp/blob/v3beta/SendGrid/Example/Example.cs). - -## Once we are out of v3 BETA, the following will apply +## Install Package To use SendGrid in your C# project, you can either <a href="https://github.com/sendgrid/sendgrid-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. @@ -64,7 +39,7 @@ PM> Install-Package SendGrid ``` Once you have the SendGrid libraries properly referenced in your project, you can include calls to them in your code. -For a sample implementation, check the [Example](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/SendGrid/Example) folder. +For a sample implementation, check the [Example](https://github.com/sendgrid/sendgrid-csharp/tree/master/SendGrid/Example) folder. Add the following namespaces to use the library: ```csharp @@ -101,7 +76,7 @@ namespace Example Content content = new Content("text/plain", "Textual content"); Mail mail = new Mail(from, subject, to, content); - dynamic response = sg.client.mail.send.beta.post(requestBody: mail.Get()); + dynamic response = sg.client.mail.send.post(requestBody: mail.Get()); } } } @@ -130,9 +105,9 @@ namespace Example # Usage - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html) -- [Usage Docs](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/USAGE.md) -- [Example Code](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/SendGrid/Example) -- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/SendGrid/SendGrid/Helpers/Mail) +- [Usage Docs](https://github.com/sendgrid/sendgrid-csharp/tree/master/USAGE.md) +- [Example Code](https://github.com/sendgrid/sendgrid-csharp/tree/master/SendGrid/Example) +- [v3 Web API Mail Send Helper](https://github.com/sendgrid/sendgrid-csharp/tree/master/SendGrid/SendGrid/Helpers/Mail) ## Roadmap @@ -140,14 +115,14 @@ If you are intersted in the future direction of this project, please take a look ## How to Contribute -We encourage contribution to our library, please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/CONTRIBUTING.md) guide for details. +We encourage contribution to our library, please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md) guide for details. Quick links: -- [Feature Request](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/CONTRIBUTING.md#feature_request) -- [Bug Reports](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/CONTRIBUTING.md#submit_a_bug_report) -- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/CONTRIBUTING.md#cla) -- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-csharp/tree/v3beta/CONTRIBUTING.md#improvements_to_the_codebase) +- [Feature Request](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#feature_request) +- [Bug Reports](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#submit_a_bug_report) +- [Sign the CLA to Create a Pull Request](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#cla) +- [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-csharp/tree/master/CONTRIBUTING.md#improvements_to_the_codebase) # About |