https://github.com/valeriansaliou/node-spamassassin-client
🔪 SpamAssassin client for Node. Lets you check if an email is spam or ham.
https://github.com/valeriansaliou/node-spamassassin-client
antispam email ham spam spamassassin spamc spamd
Last synced: 5 months ago
JSON representation
🔪 SpamAssassin client for Node. Lets you check if an email is spam or ham.
- Host: GitHub
- URL: https://github.com/valeriansaliou/node-spamassassin-client
- Owner: valeriansaliou
- License: mit
- Created: 2024-07-25T10:51:29.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-06T21:18:58.000Z (9 months ago)
- Last Synced: 2025-04-30T06:11:48.704Z (5 months ago)
- Topics: antispam, email, ham, spam, spamassassin, spamc, spamd
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/spamassassin-client
- Size: 61.5 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# node-spamassassin-client
[](https://github.com/valeriansaliou/node-spamassassin-client/actions?query=workflow%3A%22Test+and+Build%22) [](https://github.com/valeriansaliou/node-spamassassin-client/actions?query=workflow%3A%22Build+and+Release%22) [](https://www.npmjs.com/package/spamassassin-client) [](https://www.npmjs.com/package/spamassassin-client)
**SpamAssassin client, that lets you check if an email is spam or ham.**
This library aims at being as correct and lightweight as possible, built as an alternative to all other SpamAssassin client libraries which are 10+ years old, unmaintained and buggy.
All functions in this library return Promise objects. TypeScript definitions are also provided.
**🇸🇮 Crafted in Ljubljana, Slovenia.**
## Who uses it?
Crisp
Yournotify
_👋 You use spamassassin-client and you want to be listed there? [Contact me](https://valeriansaliou.name/)._
## How to install?
Include `spamassassin-client` in your `package.json` dependencies.
Alternatively, you can run `npm install spamassassin-client --save`.
## How to use?
### Check if an email is spam
#### 1. Create a client
```javascript
var SpamAssassinClient = require("spamassassin-client").SpamAssassinClient;
var spamAssassin = new SpamAssassinClient({
host : "127.0.0.1"
});
```
#### 2. Check an email
```javascript
spamAssassin.check(message)
.then(function(result) {
// (Handle result here)
})
.catch(function(error) {
// (Handle error here)
});
```
### Tunnel to a remote SpamAssassin
If you need to test this library on your local computer, while using a remote SpamAssassin instance, you can easily open a SSH tunnel to this instance:
```sh
ssh -L 127.0.0.1:783:[remote_spamd_ip]:783 root@[remote_ssh_hostname]
```
You will need root permissions to bind to `783` on your local machine, so you might need to `sudo`.
_👉 Make sure to replace `[remote_spamd_ip]` and `[remote_ssh_hostname]` with the IP address SpamAssassin is listening on, and your server hostname._
## Available options
Those options can be passed when constructing a new `SpamAssassinClient` instance:
* `host`: the hostname or IP address of the SpamAssassin server (_defaults to `127.0.0.1`_);
* `port`: the port of the SpamAssassin server (_defaults to `783`_);
* `timeout`: the timeout in seconds of the socket connection to the SpamAssassin server (_defaults to `10`_);
## Available methods
Those methods can be called on a `SpamAssassinClient` instance:
* `spamAssassin.check(message)`: checks an email for spam, returns `Promise<{ score, spam }>`;
* `spamAssassin.symbols(message)`: checks an email for spam and get its symbols, returns `Promise<{ score, spam, symbols }>`;
* `spamAssassin.report(message)`: checks an email for spam and generate a report, returns `Promise<{ score, spam, report }>`;
* `spamAssassin.ping()`: checks for the SpamAssassin connection health, returns `Promise<{}>`;
Note that all methods also return the `code` and `message` properties.