spf

Documentation

Index

• type SPF
  • func New(emailAddress string, sourceIPAddress string) *SPF
  • func (spf *SPF) AllRecord() string
  • func (spf *SPF) Process()

Types

type SPF

type SPF struct {
	ValidIPRanges []string //Contains a list of valid CIDR ranges, as defined in the SPF record
	Domain        string   //The domain we're checking SPF for
	EmailAddress  string   //The email address we're pretending to send as
	IPAddress     string   //The IP address we're pretending to send from
	IsValid       bool     //Will be true if IPAddress is found in ValidIPRanges
	FoundCIDR     string   //The actual CIDR range our IP is found in
	// contains filtered or unexported fields
}

SPF wraps all of our information into a nice little struct

func New

func New(emailAddress string, sourceIPAddress string) *SPF

New returns an SPF struct, given an email address and a source IP.

func (*SPF) AllRecord

func (spf *SPF) AllRecord() string

AllRecord returns a string containing "SoftFail", "Fail", or "None".

func (*SPF) Process

func (spf *SPF) Process()

Process is where all the magic happens. It is called when we create a new SPF object. It can also be called again if you change the email address or source IP address.