# pdf-spamc-stream

> A stream-enabled module to connect to SpamAssassin spamd daemon and process requests

Latest version **1.0.5** (published 2016-10-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install pdf-spamc-stream
pnpm add pdf-spamc-stream
yarn add pdf-spamc-stream
bun add pdf-spamc-stream
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2016-10-06 |
| First published | 2016-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Schahriar SaffarShargh |
| Maintainers | streamtoto |
| Keywords | spamd, spamc, spamassassin, email, spam, stream |

## Links

- npm: https://www.npmjs.com/package/pdf-spamc-stream
- Repository: https://github.com/streamtOtO/spamc-stream
- Homepage: https://github.com/streamtOtO/spamc-stream.git#readme
- Issues: https://github.com/streamtOtO/spamc-stream.git/issues
- npm.io page: https://npm.io/package/pdf-spamc-stream

## 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

- 1.0.5 (latest) — 2016-10-06
- 1.0.4 — 2016-04-26
- 1.0.3 — 2016-04-26

## README

# spamc-stream

spamc-stream is a nodejs module that connects to spamassassin's spamd daemon. You are able to:

  - Check a message for a spam score and return back what spamassassin matched on
  - Stream Messages from any [Readable Nodejs Stream](https://nodejs.org/api/stream.html#stream_class_stream_readable)
  - Ability to train Spamassassin with Ham and Spam
  - and everything else that `spamc` is capable of


[![Build Status](https://travis-ci.org/schahriar/spamc-stream.svg)](https://travis-ci.org/schahriar/spamc-stream)

# Usage
```
npm install spamc-stream
```

This example will parse a message to spamassassin to perform a report and will callback on success using a file stream. Note that there is no transformation happening on spamc-stream's side therefore the stream is directly piped into the TCP/NET connection. 

```javascript
var fs = require('fs');
var Spamc = require('spamc-stream');
var client = new Spamc();

var reporter = client.report();

var fsStream = fs.createReadStream('./tmp/file');
fsStream.pipe(reporter);

reporter.on('report', function(report) {
  console.log("Was the email a spam?", report.isSpam);
})

reporter.on('error', function(error) {
  console.log(error);
})
```

## Connection settings
You can define connection settings such as host, port and timeout when creating a new instance:
```javascript
var Spamc = require('spamc-stream');
// Args, Host, Port, Timeout (seconds)
var client = new Spamc('localhost', 783, 15);
```
Note that the default port for Spamassassin is set to 783 and Connection Timeout is in seconds.

## Methods
- ping - Check if Spamc is working. Returns two arguments of error and pong. If Pong is true then Spamc is available.
- check `(headers:Object) Returns: PassThrough Stream` - *checks a message for a spam score and returns an object of information.* 
- report ↑ - *like symbols but matches also includes a small description.*
- symbols ↑  - *like check but also returns what the message matched on.*
- 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.*
- spam ↑ - *parse a message to spamassassin and learn it as spam*
- ham ↑ - *parse a message to spamassassin and learn it as ham*
- forget ↑ - *parse a message to spamassassin and forget it*
- tell ↑ - *ability to tell spamassassin that the message is spam*
- revoke ↑ - *abilty to tell spamassassin that the message is not spam*

***↑ : Follows the same argument pattern as the previous***

## Header
All functions take a header argument before returning a PassThrough Stream. [Documentation on these headers is available here.](https://svn.apache.org/repos/asf/spamassassin/trunk/spamd/PROTOCOL)

**Note:** To maintain protocol API compatibility it is advised to pass a 'Content-length' header with every request like so:
```javascript
var fs = require('fs');
var Spamc = require('spamc-stream');
var client = new Spamc();

var spam = fs.createReadStream('./samples/easyspam');
var spamLength = fs.statSync('./samples/easyspam').size;

var reporter = client.report({ 'Content-length': spamLength });
spam.pipe(reporter);
// ...
```


## Changelog

`1.0.5` Change iterate arrays from for loops to  forEach. Comment on if checkers of result == null, because give bad results.

## License
This module is heavily based on work of Carl Glaysher and who doesn't love the [MIT license](https://raw.githubusercontent.com/schahriar/blackwall/master/LICENSE)?

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