Stable version of node-js port

2013-10-05 20:15:54 -03:00
parent f1aabc1313
commit b26972df79
6 changed files with 595 additions and 401 deletions
--- a/readme.md
+++ b/readme.md
@@ -1,34 +1,55 @@
-# node-spamc
+# go-spamc

-node-spamc is a nodejs module that connects to spamassassin's spamd daemon. You are able to:
+go-spamc is a golang package that connects to spamassassin's spamd daemon. 
+Is a code port of nodejs module node-spamc(https://github.com/coxeh/node-spamc) 
+
+Thanks for your amazing code Carl Glaysher ;)
+
+
+
+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

-## 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
+## Methods 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
+  - `ReportIgnoreWarning` like report but matches only symbols with score > 0 "New"	
+  - `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
+  - `ReportingSpam` ability to tell spamassassin that the message is spam
+  - `RevokeSpam` abilty to tell spamassassin that the message is not spam
+ 

 ## Example
+example.go

-This example will parse a message to spamassassin to perform a report and will callback on success.
+    package main
+	
+    import (
+	   "fmt"
+	   "spamc"
+    )

-    var spamc = require('./spamc');
-    var client = new spamc();
+    func main() {
+	
+        html := "<html>Hello world. I'm not a Spam, don't kill me SpamAssassin!</html>"
+	    client := spamc.New()
+
+	    //the 2nd parameter is optional, you can set who (the unix user) do the call
+	    reply, err := client.Check(html, "saintienn")
+
+	    fmt.Println(reply.Code)
+	    fmt.Println(reply.Message)
+	    fmt.Println(reply.Vars)
+    }

-    client.report('My Message as String',function(result){
-        console.log(result);
-    });