node-spamassassin-client

KO | EN

gitlite — search

#python #react #ai #llm #golang #go #machine-learning #linux #nodejs #macos #kubernetes #vue #mcp #ios

node-spamassassin-client

(★ 9)

🔪 SpamAssassin client for Node. Lets you check if an email is spam or ham.

node-spamassassin-client 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# node-spamassassin-client

[![Test and Build](https://github.com/valeriansaliou/node-spamassassin-client/workflows/Test%20and%20Build/badge.svg)](https://github.com/valeriansaliou/node-spamassassin-client/actions?query=workflow%3A%22Test+and+Build%22) [![Build and Release](https://github.com/valeriansaliou/node-spamassassin-client/workflows/Build%20and%20Release/badge.svg)](https://github.com/valeriansaliou/node-spamassassin-client/actions?query=workflow%3A%22Build+and+Release%22) [![NPM](https://img.shields.io/npm/v/spamassassin-client.svg)](https://www.npmjs.com/package/spamassassin-client) [![Downloads](https://img.shields.io/npm/dt/spamassassin-client.svg)](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?

<table>
<tr>
<td align="center"><a href="https://crisp.chat/"><img src="https://valeriansaliou.github.io/node-spamassassin-client/images/crisp.png" width="64" /></a></td>
<td align="center"><a href="https://yournotify.com/"><img src="https://valeriansaliou.github.io/node-spamassassin-client/images/yournotify.png" width="64" /></a></td>
</tr>
<tr>
<td align="center">Crisp</td>
<td align="center">Yournotify</td>
</tr>
</table>

_👋 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. Also, it is preferred to pass a `Buffer` type as the input value for the `message` parameter, although a `string` also works.

node-spamassassin-client

node-spamassassin-client 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

node-spamassassin-client

node-spamassassin-client 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README