# spamc

> Compute the spamassassin spam score of an email

Latest version **0.0.5** (published 2014-12-27) · 0 weekly downloads

## Install

```sh
npm install spamc
pnpm add spamc
yarn add spamc
bun add spamc
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2014-12-27 |
| First published | 2014-03-19 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Carl Glaysher |
| Maintainers | flolagale |
| Keywords | spamd, spamc, spamassassin, email, spam |

## Links

- npm: https://www.npmjs.com/package/spamc
- Repository: https://github.com/Flolagale/spamc
- Issues: https://github.com/Flolagale/spamc/issues
- npm.io page: https://npm.io/package/spamc

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2014-12-27
- 0.0.4 — 2014-12-23
- 0.0.3 — 2014-03-29
- 0.0.1 — 2014-03-19

## README

# spamc

*This is a fork from [coxeh/node-spamc](https://github.com/coxeh/node-spamc) just to publish it to npm.*

spamc is a nodejs module that connects to spamassassin's spamd daemon using the spamc interface. You are able to:

  - Check a message for a spam score and return back what spamassassin matched on
  - Ability to send messages to spamassassin to learn from
  - Ability to do everything that `spamc` is capable of

Note that the native spamassassin and spamc package must be available on your machine. On Debian / Ubuntu:

```
sudo aptitude install spamassassin spamc
```

then something like:

```
sudo npm install --save spamc
```

## Commands Available

  - `check` checks a message for a spam score and returns an object of information
  - `symbols` like `check` but also returns what the message matched on
  - `report` like `symbols` but matches also includes a small description
  - `reportIfSpam` only returns a result if message is spam
  - `process` like `check` but also returns a processed message with extra headers
  - `headers` like `check` but also returns the message headers in a array
  - `learn` abilty to parse a message to spamassassin and learn it as spam or ham
  - `tell` ability to tell spamassassin that the message is spam
  - `revoke` abilty to tell spamassassin that the message is not spam


## Example

This example will parse a message to spamassassin to perform a report and will callback on success.

```javascript
  var Spamc = require('spamc');
  var spamc = new Spamc();

  spamc.report('My full email message as a string', function (result) {
      console.log(result);
  });
```

---
_Source: https://npm.io/package/spamc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._