postmark

Documentation

Overview

Package postmark uses the free https://spamcheck.postmarkapp.com/ See https://spamcheck.postmarkapp.com/doc/ for more details.

Index

• type Response
  • func Check(email []byte, timeout int) (Response, error)
• type Rule

Types

type Response

type Response struct {
	Success bool   `json:"success"`
	Message string `json:"message"` // for errors only
	Score   string `json:"score"`
	Rules   []Rule `json:"rules"`
	Report  string `json:"report"` // ignored
}

Response struct

func Check

func Check(email []byte, timeout int) (Response, error)

Check will post the email data to Postmark

type Rule

type Rule struct {
	Score string `json:"score"`
	// Name not returned by postmark but rather extracted from description
	Name        string `json:"name"`
	Description string `json:"description"`
}

Rule struct