TROUBLESHOOTING.md

If you have a SendGrid issue, please contact our support team.

Table of Contents

• Table of Contents
• Versions
• Using the Package Manager
• Outputting the SMTPAPI Header

Versions

We follow the MAJOR.MINOR.PATCH versioning scheme as described by SemVer.org. Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the CHANGELOG section.

Using the Package Manager

We upload this library to npm whenever we make a release. This allows you to use npm for easy installation.

In most cases we recommend you download the latest version of the library, but if you need a different version, please use:

npm install @sendgrid/[package name]@X.X.X

Please check here for a list of package names.

If you are using a package.json file:

{
  ...
  "dependencies": {
    ...
    "@sendgrid/[package name]": "X.X.X"
  }
}

Outputting the SMTPAPI Header

You can output the header by the following:

  var header = new smtpapi();
  ...
  console.log(header.jsonString());

or use it in your options for the transport (Nodemailer example):

  var headers = { 'x-smtpapi': header.jsonString() };
  ...
  var mailOptions = {
    ...
    headers:  headers
  }