https://github.com/cityssm/sparkpost-bounce-check

An on-demand check of recently bounced emails delivered from SparkPost.
https://github.com/cityssm/sparkpost-bounce-check

bounce email sparkpost sparkpost-api

Last synced: 3 months ago
JSON representation

An on-demand check of recently bounced emails delivered from SparkPost.

• Host: GitHub
• URL: https://github.com/cityssm/sparkpost-bounce-check
• Owner: cityssm
• License: mit
• Created: 2023-03-24T14:27:38.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-06-26T07:02:58.000Z (about 2 years ago)
• Last Synced: 2025-02-19T13:47:01.399Z (4 months ago)
• Topics: bounce, email, sparkpost, sparkpost-api
• Language: TypeScript
• Homepage:
• Size: 241 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# SparkPost Bounce Check

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/893612fccd524ca5905be50e743bec83)](https://app.codacy.com/gh/cityssm/sparkpost-bounce-check/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

[![Maintainability](https://api.codeclimate.com/v1/badges/66b749128317c5c016f0/maintainability)](https://codeclimate.com/github/cityssm/sparkpost-bounce-check/maintainability)

[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/cityssm/sparkpost-bounce-check)](https://app.snyk.io/org/cityssm/project/589e02bc-4c75-431c-ba34-58ee621c942e)

![Bouncing Envelope](social.png)

An on-demand check of recently bounced emails delivered from SparkPost (now MessageBird Email).

## Getting Started

**This application requires the [NodeJS](https://nodejs.org/en) Javascript runtime.**

- Clone the repository,

  or [download the latest release](https://github.com/cityssm/sparkpost-bounce-check/releases)

- Run `npm install` to get the dependencies

- Copy `configSample.js` to `config.js`

- Open `config.js` and update the `sparkPostApiKey`

- Run `npm start`

## Sample Output

```json

[

  {

    "timestamp": "2023-03-24T13:14:25.000Z",

    "message_id": "1234abcd5678efgh9012",

    "rcpt_to": "[email protected]",

    "subject": "Super Important Newsletter",

    "bounce_class": "22",

    "error_code": "552",

    "raw_reason": "552 5.2.2 : user is over quota"

  }

]

```

## Helpful Links

[SparkPost Bounce Classification Codes](https://support.sparkpost.com/docs/deliverability/bounce-classification-codes)

[SparkPost Status](https://status.sparkpost.com/)