spf

Documentation

Index

• type Client
  • func (c *Client) GetStatus(remoteIP net.IP, helo, fromHeader string) (Status, error)
  • func (c *Client) ValidateAlignment(from, fromHeader string) (bool, error)
• type DomainAlignmentCheck
• type Status
  • func ParseStatus(name string) (Status, error)
  • func (x Status) MarshalText() ([]byte, error)
  • func (x Status) String() string
  • func (x *Status) UnmarshalText(text []byte) error

Types

type Client

type Client struct {
	DomainAlignment DomainAlignmentCheck
}

func (*Client) GetStatus

func (c *Client) GetStatus(remoteIP net.IP, helo, fromHeader string) (Status, error)

func (*Client) ValidateAlignment

func (c *Client) ValidateAlignment(from, fromHeader string) (bool, error)

type DomainAlignmentCheck

type DomainAlignmentCheck interface {
	ValidateDomainAlignment(a, b string) error
}

type Status

type Status int

Status is a description of the DKIM status

 ENUM(
	none
	fail
	pass
	unknown

)

const (
	// StatusNone is a Status of type None
	StatusNone Status = iota
	// StatusFail is a Status of type Fail
	StatusFail
	// StatusPass is a Status of type Pass
	StatusPass
	// StatusUnknown is a Status of type Unknown
	StatusUnknown
)

func ParseStatus

func ParseStatus(name string) (Status, error)

ParseStatus attempts to convert a string to a Status

func (Status) MarshalText

func (x Status) MarshalText() ([]byte, error)

MarshalText implements the text marshaller method

func (Status) String

func (x Status) String() string

String implements the Stringer interface.

func (*Status) UnmarshalText

func (x *Status) UnmarshalText(text []byte) error

UnmarshalText implements the text unmarshaller method