diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e861e0e2..e3645f774 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -216,7 +216,7 @@ All notable changes to this project will be documented in this file. - [PR #779](https://github.com/sendgrid/sendgrid-nodejs/pull/779): Contributing.md broken links fix. Big thanks to [Arshad Kazmi](https://github.com/arshadkazmi42) for the PR! - [PR #583](https://github.com/sendgrid/sendgrid-nodejs/pull/583): Fix README instructions and replace stray tab indentation by spaces. Big thanks to [Adam Reis](https://github.com/adamreisnz) for the PR! - [PR #522](https://github.com/sendgrid/sendgrid-nodejs/pull/522): Comma bug in name. Big thanks to [Jordan Tepper](https://github.com/HeroProtagonist) for the PR! -- [PR #824](https://github.com/sendgrid/sendgrid-nodejs/pull/824): Fix Travis CI build failures on master. Big thanks to [Tony Ho](https://github.com/tony-ho) for the PR! +- [PR #824](https://github.com/sendgrid/sendgrid-nodejs/pull/824): Fix Travis CI build failures on main. Big thanks to [Tony Ho](https://github.com/tony-ho) for the PR! - [PR #798](https://github.com/sendgrid/sendgrid-nodejs/pull/798): Update transactional-templates.md. Big thanks to [Kyle Roberts](https://github.com/kylearoberts) for the PR! ## [6.3.1] - 2018-1-18 ## @@ -319,8 +319,8 @@ This minor version bump was due to a hiccup using `lerna` to publish to npm. ### BREAKING CHANGE - BIG, HUGE, MEGA THANKS to [Adam Reis](https://github.com/adamreisnz) for this amazing PR!!! - Pull #407 via #378: API Simplification -- v6.0.0 is a complete rewrite of this SDK for all endpoints. To upgrade from v5.X and lower, we suggest you update your code based on the examples found [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/mail/USE_CASES.md) for mail send and [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md) for all other endpoints. -- Please do not hesitate to [open an issue](https://github.com/sendgrid/sendgrid-nodejs/issues) if there are any challenges and/or feedback. [PRs](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) are also welcome. +- v6.0.0 is a complete rewrite of this SDK for all endpoints. To upgrade from v5.X and lower, we suggest you update your code based on the examples found [here](packages/mail/USE_CASES.md) for mail send and [here](packages/client/USAGE.md) for all other endpoints. +- Please do not hesitate to [open an issue](https://github.com/sendgrid/sendgrid-nodejs/issues) if there are any challenges and/or feedback. [PRs](CONTRIBUTING.md) are also welcome. ## [5.2.2] - 2017-08-14 ## ### Fix @@ -474,7 +474,7 @@ That is, in both cases, error.response is present ## [4.0.2] - 2016-08-24 ## ### Added - Table of Contents in the README -- Added a [USE_CASES.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USE_CASES.md) section, with the first use case example for transactional templates +- Added a [USE_CASES.md](USE_CASES.md) section, with the first use case example for transactional templates ## [4.0.1] - 2016-08-02 ## ### Fixed @@ -503,7 +503,7 @@ That is, in both cases, error.response is present ## [3.0.11] - 2016-07-26 ## ### Added -- [Troubleshooting](https://github.com/sendgrid/sendgrid-python/blob/master/TROUBLESHOOTING.md) section +- [Troubleshooting](TROUBLESHOOTING.md) section ## [3.0.10] - 2016-07-23 ### Fixed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62958c3bb..cf344974d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,7 +63,7 @@ We welcome direct contributions to the sendgrid-nodejs code base. Thank you! ##### Prerequisites ##### - Node.js version 6, 8 or >=10 -- Please see [package.json](https://github.com/sendgrid/sendgrid-nodejs/tree/master/package.json) +- Please see [package.json](package.json) ##### Initial setup: ##### @@ -104,12 +104,12 @@ node example.js ## Understanding the Code Base -This repo is organized as a monorepo with the packages residing in the `./packages` directory. Please see the root [README.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md) for details. +This repo is organized as a monorepo with the packages residing in the `./packages` directory. Please see the root [README.md](README.md) for details. ## Codebase Overview -This repo is subdivided into 6 main [packages](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages). Each package has its dependencies (internal or external) and its source code in the `src` folder. Each package also has its isolated README files, use cases, and usage.md files. +This repo is subdivided into 6 main [packages](packages). Each package has its dependencies (internal or external) and its source code in the `src` folder. Each package also has its isolated README files, use cases, and usage.md files. To install a particular packages' dependencies. ```bash diff --git a/README.md b/README.md index f7c7353a3..577523a43 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png) +![Twilio SendGrid Logo](twilio_sendgrid_logo.png) -[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs) +[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-nodejs) [![npm version](https://badge.fury.io/js/%40sendgrid%2Fclient.svg)](https://www.npmjs.com/org/sendgrid) [![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs) [![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid) [![GitHub contributors](https://img.shields.io/github/contributors/sendgrid/sendgrid-nodejs.svg)](https://github.com/sendgrid/sendgrid-nodejs/graphs/contributors) -[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/sendgrid/sendgrid-nodejs/blob/master/LICENSE.md) +[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md) [![Open Source Helpers](https://www.codetriage.com/sendgrid/sendgrid-nodejs/badges/users.svg)](https://www.codetriage.com/sendgrid/sendgrid-nodejs) [Twilio SendGrid Docs](https://sendgrid.com/docs/index.html) @@ -14,9 +14,9 @@ **This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Node.js.** -We want this library to be community-driven, and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-nodejs/issues) and [pull requests](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) or merely upvote or comment on existing issues or pull requests. +We want this library to be community-driven, and Twilio SendGrid led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create [issues](https://github.com/sendgrid/sendgrid-nodejs/issues) and [pull requests](CONTRIBUTING.md) or merely upvote or comment on existing issues or pull requests. -For updates to this library, see our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). +For updates to this library, see our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). Subscribe to our email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) to receive emails about releases and breaking changes. @@ -38,19 +38,19 @@ We appreciate your continued support, thank you! This library is broken up into several packages as a monorepo so that you only need to install the packages necessary for your use case. This README contains information about all packages. For examples on how to get started quickly, head over to the READMEs of each package (linked and described below), which includes detailed examples. -* **[@sendgrid/mail](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/mail) - if you just want to send email** -* **[@sendgrid/client](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/client) - to use all other [Twilio SendGrid v3 Web API endpoints](https://sendgrid.com/docs/API_Reference/api_v3.html)** +* **[@sendgrid/mail](packages/mail) - if you just want to send email** +* **[@sendgrid/client](packages/client) - to use all other [Twilio SendGrid v3 Web API endpoints](https://sendgrid.com/docs/API_Reference/api_v3.html)** -* [@sendgrid/inbound-mail-parser](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/inbound-mail-parser) - help with parsing the Twilio SendGrid Inbound Parse API -* [@sendgrid/contact-importer](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/contact-importer) - help with importing contacts into the ContactDB -* [@sendgrid/helpers](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/helpers) - a collection of classes and helpers used internally by the above packages +* [@sendgrid/inbound-mail-parser](packages/inbound-mail-parser) - help with parsing the Twilio SendGrid Inbound Parse API +* [@sendgrid/contact-importer](packages/contact-importer) - help with importing contacts into the ContactDB +* [@sendgrid/helpers](packages/helpers) - a collection of classes and helpers used internally by the above packages # Announcements -**NEW:** **BREAKING CHANGE:** Please see the [Twilio SendGrid Node.js Migration Guide 6.X.X -> 7.X.X](https://github.com/sendgrid/sendgrid-nodejs/blob/master/docs/migration-guides/migrating-from-version-6-to-7.md) for details. +**NEW:** **BREAKING CHANGE:** Please see the [Twilio SendGrid Node.js Migration Guide 6.X.X -> 7.X.X](docs/migration-guides/migrating-from-version-6-to-7.md) for details. -All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. +All updates to this library are documented in our [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. # Roadmap @@ -60,17 +60,17 @@ If you are interested in the future direction of this project, please take a loo # How to Contribute -We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details. -* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature_request) -* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit_a_bug_report) -* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements_to_the_codebase) -* [Review Pull Requests](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md#code-reviews) +* [Feature Request](CONTRIBUTING.md#feature_request) +* [Bug Reports](CONTRIBUTING.md#submit_a_bug_report) +* [Improvements to the Codebase](CONTRIBUTING.md#improvements_to_the_codebase) +* [Review Pull Requests](CONTRIBUTING.md#code-reviews) # Troubleshooting -Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-nodejs/blob/master/TROUBLESHOOTING.md) for common library issues. +Please see our [troubleshooting guide](TROUBLESHOOTING.md) for common library issues. # About @@ -83,4 +83,4 @@ If you've instead found a bug in the library or would like new features added, g # License -[The MIT License (MIT)](https://github.com/sendgrid/sendgrid-nodejs/blob/master/LICENSE.md) +[The MIT License (MIT)](LICENSE.md) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index bb0b7a95b..d34dd4370 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -66,12 +66,12 @@ Click the "Clone or download" green button in [GitHub](https://github.com/sendgr ## Error Messages -To read the error message returned by SendGrid's API, please see [this example](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/mail/USE_CASES.md#success-failure-errors). +To read the error message returned by SendGrid's API, please see [this example](packages/mail/USE_CASES.md#success-failure-errors). ## Versions -We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are utilizing with 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](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases) section. +We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are utilizing with 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](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases) section. ## Environment Variables and Your SendGrid API Key diff --git a/USAGE.md b/USAGE.md index 965a7dd59..16956f7a4 100644 --- a/USAGE.md +++ b/USAGE.md @@ -3,11 +3,11 @@ This library is broken up into several packages as a monorepo so that you only need to install the packages necessary for your use case. This USAGE.md contains information about all packages. For examples on how to get started quickly, head over to the READMEs of each package (linked and described below), which includes detailed examples. -* [@sendgrid/mail](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/mail) - if you just want to send email -* [@sendgrid/client](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/client) - to use all other [SendGrid v3 Web API endpoints](https://sendgrid.com/docs/API_Reference/api_v3.html) -* [@sendgrid/inbound-mail-parser](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/inbound-mail-parser) - help with parsing the SendGrid Inbound Parse API -* [@sendgrid/contact-importer](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/contact-importer) - help with importing contacts into the ContactDB -* [@sendgrid/helpers](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/helpers) - a collection of classes and helpers used internally by the above packages +* [@sendgrid/mail](packages/mail) - if you just want to send email +* [@sendgrid/client](packages/client) - to use all other [SendGrid v3 Web API endpoints](https://sendgrid.com/docs/API_Reference/api_v3.html) +* [@sendgrid/inbound-mail-parser](packages/inbound-mail-parser) - help with parsing the SendGrid Inbound Parse API +* [@sendgrid/contact-importer](packages/contact-importer) - help with importing contacts into the ContactDB +* [@sendgrid/helpers](packages/helpers) - a collection of classes and helpers used internally by the above packages # Documentation diff --git a/docs/examples/webhooks-docker/CONTRIBUTING.md b/docs/examples/webhooks-docker/CONTRIBUTING.md index b05f2b2c2..4e9e10adb 100644 --- a/docs/examples/webhooks-docker/CONTRIBUTING.md +++ b/docs/examples/webhooks-docker/CONTRIBUTING.md @@ -50,7 +50,7 @@ Before you decide to create a new issue, please try the following: ### Please use our Bug Report Template -In order to make the process easier, we've included a [sample bug report template](https://github.com/sendgrid/sendgrid-nodejs/blob/master/ISSUE_TEMPLATE.md) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting. +In order to make the process easier, we've included a [sample bug report template](../../../ISSUE_TEMPLATE.md) (borrowed from [Ghost](https://github.com/TryGhost/Ghost/)). The template uses [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown/) for formatting. ## Improvements to the Codebase @@ -64,7 +64,7 @@ We welcome direct contributions to the sendgrid-nodejs code base. Thank you! ##### Prerequisites ##### - Node.js versions 6, 8, or >=10 -- Please see [package.json](https://github.com/sendgrid/sendgrid-nodejs/tree/master/package.json) +- Please see [package.json](../../../package.json) ##### Initial setup: ##### @@ -78,7 +78,7 @@ npm install First, get your free Twilio SendGrid account [here](https://sendgrid.com/free?source=sendgrid-nodejs). -You will need to setup the following environment to use the Twilio SendGrid examples in the [README.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md), [USAGE.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.MD) and [USE_CASES.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USE_CASES.md) files: +You will need to setup the following environment to use the Twilio SendGrid examples in the [README.md](../../../README.md), [USAGE.md](../../../USAGE.MD) and [USE_CASES.md](../../../USE_CASES.md) files: ```bash echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env @@ -105,12 +105,12 @@ node example.js ## Understanding the Code Base -This repo is organized as a monorepo with the packages residing in the `./packages` directory. Please see the root [README.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md) for details. +This repo is organized as a monorepo with the packages residing in the `./packages` directory. Please see the root [README.md](../../../README.md) for details. ## Codebase Overview -This repo is subdivided in 6 main [packages](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages). Each package has its own dependencies (internal or external) and its own source code in the `src` folder. Each package also has its isolated README files, use cases and usage.md files. +This repo is subdivided in 6 main [packages](../../../packages). Each package has its own dependencies (internal or external) and its own source code in the `src` folder. Each package also has its isolated README files, use cases and usage.md files. To install a particular packages' dependencies. ```bash @@ -157,7 +157,7 @@ Generally, we follow the style guidelines as suggested by the official language. Please run your code through: - [ESLint](http://eslint.org/) with the standard style guide. -- [esdoc](https://github.com/sendgrid/sendgrid-nodejs/blob/master/USAGE.md) to check the documentation coverage of your added code. +- [esdoc](../../../USAGE.md) to check the documentation coverage of your added code. ## Creating a Pull Request @@ -202,7 +202,7 @@ Please run your code through: 5. Locally merge (or rebase) the upstream development branch into your topic branch: ```bash - git pull [--rebase] upstream master + git pull [--rebase] upstream main ``` 6. Push your topic branch up to your fork: @@ -212,7 +212,7 @@ Please run your code through: ``` 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description against the `master` branch. All tests must be passing before we will review the PR. + with a clear title and description against the `main` branch. All tests must be passing before we will review the PR. ## Code Reviews diff --git a/docs/migration-guides/migrating-from-version-6-to-7.md b/docs/migration-guides/migrating-from-version-6-to-7.md index 86b77c622..9e32e7e07 100644 --- a/docs/migration-guides/migrating-from-version-6-to-7.md +++ b/docs/migration-guides/migrating-from-version-6-to-7.md @@ -2,12 +2,12 @@ This guide relates to changes implemented in [PR 1058](https://github.com/sendg The [request](https://github.com/request/request#deprecated) HTTP client was deprecated as of Feb 11th 2020. We have updated this helper library with the [axios](https://www.npmjs.com/package/axios) HTTP client. -In version 6.X.X, our `ClientRequest` and `ClientResponse` types exposed the raw interfaces from the `request` module directly. In version 7.X.X, the [`ClientRequest`](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/request.d.ts) and [`ClientResponse`](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/response.d.ts) objects untethers from a specific HTTP client implementation. We have maintained the core request and response interfaces exposed in test cases and usage examples, but mask everything else. +In version 6.X.X, our `ClientRequest` and `ClientResponse` types exposed the raw interfaces from the `request` module directly. In version 7.X.X, the [`ClientRequest`](../../packages/helpers/classes/request.d.ts) and [`ClientResponse`](../../packages/helpers/classes/response.d.ts) objects untethers from a specific HTTP client implementation. We have maintained the core request and response interfaces exposed in test cases and usage examples, but mask everything else. -If you are passing in request options, outside of what’s documented, to the HTTP request client, this may be a breaking change for you. Please check the [`RequestOptions` interface](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/request.d.ts) to inspect the updated options. If you rely on HTTP response data [previously available](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/request/index.d.ts#L319), this may also be a breaking change for you. Please see the [`ClientResponse`](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/response.d.ts) object for details about what data is now exposed. +If you are passing in request options, outside of what’s documented, to the HTTP request client, this may be a breaking change for you. Please check the [`RequestOptions` interface](../../packages/helpers/classes/request.d.ts) to inspect the updated options. If you rely on HTTP response data [previously available](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/HEAD/types/request/index.d.ts#L319), this may also be a breaking change for you. Please see the [`ClientResponse`](../../packages/helpers/classes/response.d.ts) object for details about what data is now exposed. ## Action steps: 1. Locate any areas in your code that utilizes request and response properties that are no longer exposed in the new interfaces. -1. Update the response values to use the new [`Response`](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/response.d.ts) object. -1. Update the request values to use the new options exposed in the [`RequestOptions`](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/helpers/classes/request.d.ts) object. +1. Update the response values to use the new [`Response`](../../packages/helpers/classes/response.d.ts) object. +1. Update the request values to use the new options exposed in the [`RequestOptions`](../../packages/helpers/classes/request.d.ts) object. diff --git a/docs/use-cases/domain-authentication.md b/docs/use-cases/domain-authentication.md index 3e468db94..2f6c13002 100644 --- a/docs/use-cases/domain-authentication.md +++ b/docs/use-cases/domain-authentication.md @@ -1,5 +1,5 @@ # How to Setup a Domain Authentication -You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#sender-authentication). +You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](../../packages/client/USAGE.md#sender-authentication). Find more information about all of Twilio SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/). diff --git a/docs/use-cases/email-activity.md b/docs/use-cases/email-activity.md index 54999b93d..06369697f 100644 --- a/docs/use-cases/email-activity.md +++ b/docs/use-cases/email-activity.md @@ -1,5 +1,5 @@ # How to View Email Activity -You can find documentation for how to use the Email Activity Feed via the UI [here](https://sendgrid.com/docs/ui/analytics-and-reporting/email-activity-feed/) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#messages). +You can find documentation for how to use the Email Activity Feed via the UI [here](https://sendgrid.com/docs/ui/analytics-and-reporting/email-activity-feed/) and via API [here](../../packages/client/USAGE.md#messages). Find more information about getting started with the Email Activity Feed API [here](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html). diff --git a/docs/use-cases/email-stats.md b/docs/use-cases/email-stats.md index ac7f97f2b..4fde258eb 100644 --- a/docs/use-cases/email-stats.md +++ b/docs/use-cases/email-stats.md @@ -1,5 +1,5 @@ # How to View Email Statistics -You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#stats). +You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](../../packages/client/USAGE.md#stats). Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as Twilio SendGrid processes your email. diff --git a/docs/use-cases/scheduled-send.md b/docs/use-cases/scheduled-send.md index 51cd9c339..3653c20a5 100644 --- a/docs/use-cases/scheduled-send.md +++ b/docs/use-cases/scheduled-send.md @@ -21,7 +21,7 @@ await sgMail.send(msg); ## [To Cancel or Pause Your Scheduled Send](https://sendgrid.com/docs/for-developers/sending-email/stopping-a-scheduled-send/#canceling-transactional-email): -1. Create a [Batch ID](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#create-a-batch-id). +1. Create a [Batch ID](../../packages/client/USAGE.md#create-a-batch-id). 2. Assign Batch ID to a `msg` object: ```js const msg = { @@ -35,4 +35,4 @@ const msg = { await sgMail.send(msg); ``` -3. [Update your Batch ID](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#post-userscheduled_sends) with a `cancel` or `pause` status. +3. [Update your Batch ID](../../packages/client/USAGE.md#post-userscheduled_sends) with a `cancel` or `pause` status. diff --git a/first-timers.md b/first-timers.md index 483ca0ac0..b0aaabfcb 100644 --- a/first-timers.md +++ b/first-timers.md @@ -37,7 +37,7 @@ 6. __Locally merge (or rebase)__ the upstream development branch into your topic branch: ``` - git pull [--rebase] upstream master + git pull [--rebase] upstream main ``` 7. __Push__ your topic branch up to your fork: @@ -45,7 +45,7 @@ git push origin ``` 8. __[Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#changing-the-branch-range-and-destination-repository/)__ - with a clear title and description against the `master` branch. All tests must be passing before we will review the PR. + with a clear title and description against the `main` branch. All tests must be passing before we will review the PR. ### Important notice Before creating a pull request, make sure that you respect the repository's constraints regarding contributions. You can find them in the [CONTRIBUTING.md](./CONTRIBUTING.md) file. diff --git a/package.json b/package.json index 2701f7f9c..ae2234142 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "test": "npm run test:all -s", "coverage": "open -a \"Google Chrome\" ./coverage/lcov-report/index.html" }, - "description": "![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png)", + "description": "![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-nodejs/raw/HEAD/twilio_sendgrid_logo.png)", "bugs": { "url": "https://github.com/sendgrid/sendgrid-nodejs/issues" }, diff --git a/packages/client/README.md b/packages/client/README.md index 0afbc74b9..9382333e1 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -1,8 +1,8 @@ -[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs) +[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-nodejs) [![npm version](https://badge.fury.io/js/%40sendgrid%2Fclient.svg)](https://www.npmjs.com/org/sendgrid) [![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs) -**This package is part of a monorepo, please see [this README](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md) for details.** +**This package is part of a monorepo, please see [this README](../../README.md) for details.** # Client for the SendGrid v3 Web API This client library is used by the other [Twilio SendGrid service packages](https://www.npmjs.com/org/sendgrid) to make requests to the [Twilio SendGrid v3 Web API](https://sendgrid.com/docs/API_Reference/api_v3.html). You can also use it independently to make custom requests to the Twilio SendGrid v3 Web API and other HTTP APIs. @@ -49,7 +49,7 @@ yarn add @sendgrid/client ## General v3 Web API Usage Example -Please see [USAGE.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md) for all endpoint examples for the [Twilio SendGrid v3 Web API](https://sendgrid.com/docs/API_Reference/api_v3.html). +Please see [USAGE.md](USAGE.md) for all endpoint examples for the [Twilio SendGrid v3 Web API](https://sendgrid.com/docs/API_Reference/api_v3.html). ```js const client = require('@sendgrid/client'); @@ -94,7 +94,7 @@ sgClient2.setApiKey('KEY2'); # Announcements -All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. +All updates to this library are documented in our [CHANGELOG](../../CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. # Roadmap @@ -104,16 +104,16 @@ If you are interested in the future direction of this project, please take a loo # How to Contribute -We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](../../CONTRIBUTING.md) guide for details. -* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature-request) -* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit-a-bug-report) -* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements-to-the-codebase) +* [Feature Request](../../CONTRIBUTING.md#feature-request) +* [Bug Reports](../../CONTRIBUTING.md#submit-a-bug-report) +* [Improvements to the Codebase](../../CONTRIBUTING.md#improvements-to-the-codebase) # Troubleshooting -Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-nodejs/blob/master/TROUBLESHOOTING.md) for common library issues. +Please see our [troubleshooting guide](../../TROUBLESHOOTING.md) for common library issues. # About @@ -124,4 +124,4 @@ If you need help installing or using the library, please check the [Twilio SendG If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo! -![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png) +![Twilio SendGrid Logo](../../twilio_sendgrid_logo.png) diff --git a/packages/client/USAGE.md b/packages/client/USAGE.md index 90ebe38fb..6ea502164 100644 --- a/packages/client/USAGE.md +++ b/packages/client/USAGE.md @@ -2589,7 +2589,7 @@ For more detailed information about how to use the v3 Mail Send endpoint, please ### POST /mail/send -// This endpoint has a helper, check it out [here](https://github.com/sendgrid/sendgrid-nodejs/tree/master/packages/mail). +// This endpoint has a helper, check it out [here](../mail). ```javascript const data = { diff --git a/packages/client/USE_CASES.md b/packages/client/USE_CASES.md index 619ff31df..933b42d75 100644 --- a/packages/client/USE_CASES.md +++ b/packages/client/USE_CASES.md @@ -10,20 +10,20 @@ This document provides examples for specific Twilio SendGrid v3 API non-mail/sen # How to Setup a Domain Authentication -You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#sender-authentication). +You can find documentation for how to setup a domain authentication via the UI [here](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) and via API [here](USAGE.md#sender-authentication). Find more information about all of Twilio SendGrid's authentication related documentation [here](https://sendgrid.com/docs/ui/account-and-settings/). # How to View Email Statistics -You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#stats). +You can find documentation for how to view your email statistics via the UI [here](https://app.sendgrid.com/statistics) and via API [here](USAGE.md#stats). Alternatively, we can post events to a URL of your choice via our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html) about events that occur as Twilio SendGrid processes your email. # How to use the Email Activity Feed -You can find documentation for how to use the Email Activity Feed via the UI [here](https://sendgrid.com/docs/ui/analytics-and-reporting/email-activity-feed/) and via API [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/packages/client/USAGE.md#messages). +You can find documentation for how to use the Email Activity Feed via the UI [here](https://sendgrid.com/docs/ui/analytics-and-reporting/email-activity-feed/) and via API [here](USAGE.md#messages). Find more information about getting started with the Email Activity Feed API [here](https://sendgrid.com/docs/API_Reference/Web_API_v3/Tutorials/getting_started_email_activity_api.html). diff --git a/packages/contact-importer/README.md b/packages/contact-importer/README.md index 86ab34899..7a15299f4 100644 --- a/packages/contact-importer/README.md +++ b/packages/contact-importer/README.md @@ -1,24 +1,24 @@ -[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs) +[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-nodejs) [![npm version](https://badge.fury.io/js/%40sendgrid%2Fclient.svg)](https://www.npmjs.com/org/sendgrid) [![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs) -**This package is part of a monorepo, please see [this README](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md) for details.** +**This package is part of a monorepo, please see [this README](../../README.md) for details.** To be notified when this package is updated, please subscribe to email [notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. # How to Contribute -We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](../../CONTRIBUTING.md) guide for details. -* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature-request) -* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit-a-bug-report) -* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements-to-the-codebase) +* [Feature Request](../../CONTRIBUTING.md#feature-request) +* [Bug Reports](../../CONTRIBUTING.md#submit-a-bug-report) +* [Improvements to the Codebase](../../CONTRIBUTING.md#improvements-to-the-codebase) # Troubleshooting -Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-nodejs/blob/master/TROUBLESHOOTING.md) for common library issues. +Please see our [troubleshooting guide](../../TROUBLESHOOTING.md) for common library issues. # About @@ -29,4 +29,4 @@ If you need help installing or using the library, please check the [Twilio SendG If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo! -![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png) +![Twilio SendGrid Logo](../../twilio_sendgrid_logo.png) diff --git a/packages/helpers/README.md b/packages/helpers/README.md index 88880a757..0e3ac83ef 100644 --- a/packages/helpers/README.md +++ b/packages/helpers/README.md @@ -1,8 +1,8 @@ -[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs) +[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-nodejs) [![npm version](https://badge.fury.io/js/%40sendgrid%2Fclient.svg)](https://www.npmjs.com/org/sendgrid) [![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs) -**This package is part of a monorepo, please see [this README](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md) for details.** +**This package is part of a monorepo, please see [this README](../../README.md) for details.** # Support classes and helpers for the SendGrid NodeJS libraries This is a collection of classes and helpers used internally by the @@ -30,11 +30,11 @@ Internal helpers that mostly speak for themselves. # How to Contribute -We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/HEAD/CONTRIBUTING.md) guide for details. -* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature-request) -* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit-a-bug-report) -* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements-to-the-codebase) +* [Feature Request](../../CONTRIBUTING.md#feature-request) +* [Bug Reports](../../CONTRIBUTING.md#submit-a-bug-report) +* [Improvements to the Codebase](../../CONTRIBUTING.md#improvements-to-the-codebase) # About @@ -45,4 +45,4 @@ If you need help installing or using the library, please check the [Twilio SendG If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo! -![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png) +![Twilio SendGrid Logo](../../twilio_sendgrid_logo.png) diff --git a/packages/inbound-mail-parser/README.md b/packages/inbound-mail-parser/README.md index 84b9c8211..391441779 100644 --- a/packages/inbound-mail-parser/README.md +++ b/packages/inbound-mail-parser/README.md @@ -1,8 +1,8 @@ -[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs) +[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-nodejs) [![npm version](https://badge.fury.io/js/%40sendgrid%2Fclient.svg)](https://www.npmjs.com/org/sendgrid) [![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs) -**This package is part of a monorepo, please see [this README](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md) for details.** +**This package is part of a monorepo, please see [this README](../../README.md) for details.** # Inbound Parse Service for the [SendGrid Inbound Parse API](https://sendgrid.com/docs/API_Reference/Parse_Webhook/inbound_email.html) This package helps get you started consuming and processing [Inbound Parse](https://sendgrid.com/docs/API_Reference/Parse_Webhook/inbound_email.html) data. @@ -35,16 +35,16 @@ yarn add @sendgrid/inbound-mail-parser # How to Contribute -We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/HEAD/CONTRIBUTING.md) guide for details. -* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature-request) -* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit-a-bug-report) -* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements-to-the-codebase) +* [Feature Request](../../CONTRIBUTING.md#feature-request) +* [Bug Reports](../../CONTRIBUTING.md#submit-a-bug-report) +* [Improvements to the Codebase](../../CONTRIBUTING.md#improvements-to-the-codebase) # Troubleshooting -Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-nodejs/blob/master/TROUBLESHOOTING.md) for common library issues. +Please see our [troubleshooting guide](../../TROUBLESHOOTING.md) for common library issues. # About @@ -55,4 +55,4 @@ If you need help installing or using the library, please check the [Twilio SendG If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo! -![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png) +![Twilio SendGrid Logo](../../twilio_sendgrid_logo.png) diff --git a/packages/mail/README.md b/packages/mail/README.md index 7c5ef8aa1..cde798a2b 100644 --- a/packages/mail/README.md +++ b/packages/mail/README.md @@ -1,8 +1,8 @@ -[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=master)](https://travis-ci.org/sendgrid/sendgrid-nodejs) +[![BuildStatus](https://travis-ci.org/sendgrid/sendgrid-nodejs.svg?branch=main)](https://travis-ci.org/sendgrid/sendgrid-nodejs) [![npm version](https://badge.fury.io/js/%40sendgrid%2Fclient.svg)](https://www.npmjs.com/org/sendgrid) [![Email Notifications Badge](https://dx.sendgrid.com/badge/nodejs)](https://dx.sendgrid.com/newsletter/nodejs) -**This package is part of a monorepo, please see [this README](https://github.com/sendgrid/sendgrid-nodejs/blob/master/README.md) for details.** +**This package is part of a monorepo, please see [this README](../../README.md) for details.** # Mail Service for the SendGrid v3 Web API This is a dedicated service for interaction with the mail endpoint of the [SendGrid v3 API](https://sendgrid.com/docs/API_Reference/api_v3.html). @@ -49,7 +49,7 @@ Verify an email address or domain in the [Sender Authentication tab](https://app # Quick Start, Hello Email The following is the minimum needed code to send a simple email. Use this example, and modify the `to` and `from` variables: -For more complex use cases, please see [USE_CASES.md](https://github.com/sendgrid/sendgrid-nodejs/blob/master/docs/use-cases/README.md#email-use-cases). +For more complex use cases, please see [USE_CASES.md](../../docs/use-cases/README.md#email-use-cases). ```js const sgMail = require('@sendgrid/mail'); @@ -88,21 +88,21 @@ sgMail After executing the above code, you should have an email in the inbox of the recipient. You can check the status of your email [in the UI](https://app.sendgrid.com/email_activity?). Alternatively, we can post events to a URL of your choice using our [Event Webhook](https://sendgrid.com/docs/API_Reference/Webhooks/event.html). This gives you data about the events that occur as Twilio SendGrid processes your email. # Troubleshooting -Please see our [troubleshooting guide](https://github.com/sendgrid/sendgrid-nodejs/blob/master/TROUBLESHOOTING.md) for common library issues. +Please see our [troubleshooting guide](../../TROUBLESHOOTING.md) for common library issues. # Announcements -All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. +All updates to this library are documented in our [CHANGELOG](../../CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-nodejs/releases). You may also subscribe to email [release notifications](https://dx.sendgrid.com/newsletter/nodejs) for releases and breaking changes. # Roadmap If you are interested in the future direction of this project, please take a look at our open [issues](https://github.com/sendgrid/sendgrid-nodejs/issues) and [pull requests](https://github.com/sendgrid/sendgrid-nodejs/pulls). We would love to hear your feedback! # How to Contribute -We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries (you might even score some nifty swag), please see our [CONTRIBUTING](https://github.com/sendgrid/sendgrid-nodejs/blob/HEAD/CONTRIBUTING.md) guide for details. -* [Feature Request](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#feature-request) -* [Bug Reports](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#submit-a-bug-report) -* [Improvements to the Codebase](https://github.com/sendgrid/sendgrid-nodejs/tree/master/CONTRIBUTING.md#improvements-to-the-codebase) +* [Feature Request](../../CONTRIBUTING.md#feature-request) +* [Bug Reports](../../CONTRIBUTING.md#submit-a-bug-report) +* [Improvements to the Codebase](../../CONTRIBUTING.md#improvements-to-the-codebase) # About @sendgrid/mail is maintained and funded by Twilio SendGrid, Inc. The names and logos for @sendgrid/mail are trademarks of Twilio SendGrid, Inc. @@ -111,4 +111,4 @@ If you need help installing or using the library, please check the [Twilio SendG If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo! -![Twilio SendGrid Logo](https://github.com/sendgrid/sendgrid-python/raw/master/twilio_sendgrid_logo.png) +![Twilio SendGrid Logo](../../twilio_sendgrid_logo.png) diff --git a/packages/mail/USE_CASES.md b/packages/mail/USE_CASES.md index c52fd118a..d96702069 100644 --- a/packages/mail/USE_CASES.md +++ b/packages/mail/USE_CASES.md @@ -1 +1 @@ -Please see the Email Use Cases [here](https://github.com/sendgrid/sendgrid-nodejs/blob/master/docs/use-cases/README.md#email-use-cases). +Please see the Email Use Cases [here](../../docs/use-cases/README.md#email-use-cases). diff --git a/packages/subscription-widget/README.md b/packages/subscription-widget/README.md index 5ac2912f2..1017245c0 100644 --- a/packages/subscription-widget/README.md +++ b/packages/subscription-widget/README.md @@ -4,7 +4,7 @@ Note: This is not an officially supported Twilio SendGrid library This is an open source repository to add a flexible email subscription widget, like the one shown below, to any website using [Twilio SendGrid](https://sendgrid.com/). After following these directions, you'll be able to add a snippet of HTML to any website that will collect email addresses for your app or business. This widget utilizes [double opt-in](https://sendgrid.com/docs/Glossary/opt_in_email.html) functionality, which means users must confirm their email addresses by clicking an email that is automatically sent to their provided email address. -![alt text](https://github.com/devchas/sendgrid_subscription_widget/blob/master/server/static/sample-form.png "Sample Form") +![alt text](https://github.com/devchas/sendgrid_subscription_widget/blob/HEAD/server/static/sample-form.png "Sample Form") ## Requirements @@ -46,12 +46,12 @@ exports.templateId = "dbc810ec-b776-4345-b0c7-02e2bbcd2ab4" ``` #### Add Contact to a Custom Marketing List (Optional) -By default, the widget is configured to save a new contact to your master list of ALL CONTACTS. However, you may choose to save new contacts to a specified custom list as well. To do so, you must first create a new contact list by navigating to Marketing Campaigns -> Contacts, and then click the blue button in the top right corner of the page. Once the list is created, you will require the list ID. You can find this number by navigating to the list and looking at the URL. The list ID will be the numbers following the last forward slash. For example, the list ID of a list with URL of https://sendgrid.com/marketing_campaigns/lists/651138 would be 651138. Once you have created a new list, change the value of exports.listId to the ID of that marketing list. This value is null by default. +By default, the widget is configured to save a new contact to your main list of ALL CONTACTS. However, you may choose to save new contacts to a specified custom list as well. To do so, you must first create a new contact list by navigating to Marketing Campaigns -> Contacts, and then click the blue button in the top right corner of the page. Once the list is created, you will require the list ID. You can find this number by navigating to the list and looking at the URL. The list ID will be the numbers following the last forward slash. For example, the list ID of a list with URL of https://sendgrid.com/marketing_campaigns/lists/651138 would be 651138. Once you have created a new list, change the value of exports.listId to the ID of that marketing list. This value is null by default. #### Use a Transactional Template (Optional) You may also send your confirmation email using [transactional email templates](https://sendgrid.com/solutions/transactional-email-templates/) to give your email a more professional look and feel. To do so, you must first create a template by following the steps provided in [this guide](https://sendgrid.com/docs/User_Guide/Transactional_Templates/index.html). Once you have created a custom transactional email template, change the value of the exports.templateId to the ID of the template you created. If you choose to use templates, **you must include a substitution tag named "link_insert"**. This will be substituted with the link that signs up a user in the double opt-in process. (Example template below) -![alt text](https://github.com/devchas/sendgrid_subscription_widget/blob/master/server/static/template.png "Transactional Email Template") +![alt text](https://github.com/devchas/sendgrid_subscription_widget/blob/HEAD/server/static/template.png "Transactional Email Template") #### Edit the Form with Your Custom URL Navigate to the index.html file (server -> static -> index.html) and change the action in the form to reflect your app's URL. Remember to leave "/confirmEmail" at the end. The text in this file is what you will embed in your website. See below for an example. diff --git a/twilio_sendgrid_logo.png b/twilio_sendgrid_logo.png new file mode 100644 index 000000000..a4c22239a Binary files /dev/null and b/twilio_sendgrid_logo.png differ