spamassassin

Documentation

Overview

Package spamassassin will return results from either a SpamAssassin server or Postmark's public API depending on configuration

Index

• func Ping() error
• func SetService(s string)
• func SetTimeout(t int)
• type Result
  • func Check(msg []byte) (Result, error)
• type Rule

Functions

func Ping

func Ping() error

Ping returns whether a service is active or not

func SetService

func SetService(s string)

SetService defines which service should be used.

func SetTimeout

func SetTimeout(t int)

SetTimeout defines the timeout

Types

type Result

type Result struct {
	// Whether the message is spam or not
	IsSpam bool
	// If populated will return an error string
	Error string
	// Total spam score based on triggered rules
	Score float64
	// Spam rules triggered
	Rules []Rule
}

Result is a SpamAssassin result

swagger:model SpamAssassinResponse

func Check

func Check(msg []byte) (Result, error)

Check will return a Result

type Rule

type Rule struct {
	// Spam rule score
	Score float64
	// SpamAssassin rule name
	Name string
	// SpamAssassin rule description
	Description string
}

Rule struct