summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTushar Bhushan <tushar.bhushan@yahoo.com>2015-10-07 15:10:39 -0700
committerTushar Bhushan <tushar.bhushan@yahoo.com>2015-10-07 15:10:39 -0700
commitc31b9aee1ecdf76e819a255ca633ff6d558f5dbc (patch)
tree0e6935f2299b90d0e1122e382a88c077999101f1
parent39dad636294885d7d6b7eabe5fa5795b0d72dfe7 (diff)
downloadsendgrid-nodejs-c31b9aee1ecdf76e819a255ca633ff6d558f5dbc.zip
sendgrid-nodejs-c31b9aee1ecdf76e819a255ca633ff6d558f5dbc.tar.gz
sendgrid-nodejs-c31b9aee1ecdf76e819a255ca633ff6d558f5dbc.tar.bz2
updated readme with changes
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index c9c7e44..f5d2fe6 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,18 @@ This nodejs module allows you to quickly and easily send emails through SendGrid
[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs)
[![NPM version](https://badge.fury.io/js/sendgrid.svg)](http://badge.fury.io/js/sendgrid)
+WARNING: This module was recently upgraded from [1.9.x](https://github.com/sendgrid/sendgrid-nodejs/tree/v1.9.1) to 2.X. There were API breaking changes for various method names. See [usage](https://github.com/sendgrid/sendgrid-nodejs#usage) for up to date method names.
+
+PLEASE READ THIS
+
+TLDR: If you upgrade and don't change your code appropriately, things WILL break.
+
+One of the most notable changes is how addTo() behaves. We are now using our Web API parameters instead of the X-SMTPAPI header. What this means is that if you call addTo() multiple times for an email, ONE email will be sent with each email address visible to everyone. To utilize the original behavior of having an individual personalized email sent to each recipient you must now use addSmtpapiTo(). This will break substitutions if there is more than one To address added unless you update to use addSmtpapiTo().
+
+Smtpapi addressing methods cannot be mixed with non Smtpapi addressing methods. Meaning you cannot currently use Cc and Bcc with addSmtpapiTo().
+
+The send() method now raises a \SendGrid\Exception by default if the response code is not 200 and returns an instance of \SendGrid\Response.
+
```javascript
var sendgrid = require('sendgrid')(sendgrid_api_key);
sendgrid.send({