more fixes
This commit is contained in:
21
readme.md
21
readme.md
@@ -1,5 +1,4 @@
|
|||||||
node-spamc
|
# node-spamc
|
||||||
=========
|
|
||||||
|
|
||||||
node-spamc is a nodejs module that connects to spamassassin's spamd daemon. You are able to:
|
node-spamc is a nodejs module that connects to spamassassin's spamd daemon. You are able to:
|
||||||
|
|
||||||
@@ -7,8 +6,7 @@ node-spamc is a nodejs module that connects to spamassassin's spamd daemon. You
|
|||||||
- Ability to send messages to spamassassin to learn from
|
- Ability to send messages to spamassassin to learn from
|
||||||
- Ability to do everything that `spamc` is capable of
|
- Ability to do everything that `spamc` is capable of
|
||||||
|
|
||||||
Commands Available
|
## Commands Available
|
||||||
--------------
|
|
||||||
|
|
||||||
- `check` checks a message for a spam score and returns an object of information
|
- `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
|
- `symbols` like `check` but also returns what the message matched on
|
||||||
@@ -21,15 +19,16 @@ Commands Available
|
|||||||
- `revoke` abilty to tell spamassassin that the message is not spam
|
- `revoke` abilty to tell spamassassin that the message is not spam
|
||||||
|
|
||||||
|
|
||||||
Example
|
## Example
|
||||||
--------------
|
|
||||||
This example will parse a message to spamassassin to perform a report and will callback on success.
|
This example will parse a message to spamassassin to perform a report and will callback on success.
|
||||||
|
|
||||||
```var spamc = require('./spamc');
|
var spamc = require('./spamc');
|
||||||
var client = new spamc();
|
var client = new spamc();
|
||||||
|
|
||||||
|
client.report('My Message as String',function(result){
|
||||||
|
console.log(result);
|
||||||
|
});
|
||||||
|
|
||||||
client.report('My Message as String',function(result){
|
|
||||||
console.log(result);
|
|
||||||
});```
|
|
||||||
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user