The Official Twilio SendGrid Led, Community Driven Node.js API Library
Installations
npm install @sendgrid/clientScore
58.8
Supply Chain
99.6
Quality
82.3
Maintenance
100
Vulnerability
100
License
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
>=12.*
Typescript Support
No
Node Version
16.20.2
NPM Version
lerna/8.1.8/node@v16.20.2+x64 (linux)
Statistics
3,001 Stars
1,524 Commits
780 Forks
238 Watching
17 Branches
508 Contributors
Updated on 26 Nov 2024
Languages
JavaScript (95.84%)
TypeScript (3.32%)
HTML (0.6%)
Makefile (0.19%)
Dockerfile (0.04%)
Procfile (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
224,841,414
Last day
-6.3%
251,814
Compared to previous day
Last week
3.1%
1,434,974
Compared to previous week
Last month
6.4%
6,073,752
Compared to previous month
Last year
18.5%
65,665,947
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
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 and pull requests or merely upvote or comment on existing issues or pull requests.
For updates to this library, see our CHANGELOG and releases.
If you need support using Sendgrid, please check the Twilio SendGrid Support Help Center.
Table of Contents
- Table of Contents
- Introduction - Please Read First
- Announcements
- How to Contribute
- Troubleshooting
- About
- License
Introduction - Please Read First
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 - if you just want to send email
-
@sendgrid/client - to use all other Twilio SendGrid v3 Web API endpoints
-
@sendgrid/inbound-mail-parser - help with parsing the Twilio SendGrid Inbound Parse API
-
@sendgrid/contact-importer - help with importing contacts into the ContactDB
-
@sendgrid/helpers - a collection of classes and helpers used internally by the above packages
-
@sendgrid/eventwebhook - help with validating events sent by SendGrid to your event webhook
Announcements
BREAKING CHANGE: Please see the Twilio SendGrid Node.js Migration Guide 6.X.X -> 7.X.X for details.
All updates to this library are documented in our CHANGELOG and releases.
How to Contribute
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
Troubleshooting
Please see our troubleshooting guide for common library issues.
About
sendgrid-nodejs is maintained and funded by Twilio SendGrid, Inc. The names and logos for sendgrid-nodejs are trademarks of Twilio SendGrid, Inc.
Support
If you need help using SendGrid, please check the Twilio SendGrid Support Help Center.
License
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
Found 12/30 approved changesets -- score normalized to 4
Reason
4 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 3
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/pr-lint.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-and-deploy.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 13 are checked with a SAST tool
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/pr-lint.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/pr-lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-deploy.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/test-and-deploy.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-and-deploy.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/test-and-deploy.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-deploy.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/test-and-deploy.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-and-deploy.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/test-and-deploy.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-and-deploy.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/test-and-deploy.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-and-deploy.yml:73: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/test-and-deploy.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-and-deploy.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/sendgrid/sendgrid-nodejs/test-and-deploy.yml/main?enable=pin
- Warn: containerImage not pinned by hash: Dockerfile:2
- Warn: containerImage not pinned by hash: docs/examples/webhooks-docker/Dockerfile:1: pin your Docker image by updating node:8.9-alpine to node:8.9-alpine@sha256:6bb963d58da845cf66a22bc5a48bb8c686f91d30240f0798feb0d61a2832fc46
- Warn: npmCommand not pinned by hash: docs/examples/webhooks-docker/Dockerfile:5
- Warn: npmCommand not pinned by hash: .github/workflows/test-and-deploy.yml:65
- Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 5 third-party GitHubAction dependencies pinned
- Info: 0 out of 2 containerImage dependencies pinned
- Info: 0 out of 2 npmCommand dependencies pinned
Score
4.5
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More