spam

Documentation

Index

• Variables
• type Result
  • func Check(ctx context.Context, scriptFile string, msg *email.Message) (*Result, error)
• type Status

Variables

var Functions = rudi.Functions{
	"spam":       rudi.NewFunctionBuilder(spamFuncWithRule, spamFunc).WithDescription("marks an e-mail as spam").Build(),
	"ham":        rudi.NewFunctionBuilder(hamFuncWithRule, hamFunc).WithDescription("marks an e-mail as ham").Build(),
	"maybe-spam": rudi.NewFunctionBuilder(maybeSpamFuncWithRule, maybeSpamFunc).WithDescription("marks an e-mail as maybe spam").Build(),
}

Types

type Result

type Result struct {
	Status Status `json:"status"`
	Rule   string `json:"rule"`
}

func Check

func Check(ctx context.Context, scriptFile string, msg *email.Message) (*Result, error)

type Status

type Status string

const (
	Spam      Status = "spam"
	MaybeSpam Status = "maybe-spam"
	Ham       Status = "ham"
)