mtasts

README

go-mtasts

A Go library for SMTP MTA Strict Transport Security.

License

MIT

Documentation

Overview

Package mtasts handles SMTP MTA Strict Transport Security.

Index

• type Policy
  • func Fetch(domain string) (*Policy, error)
• type PolicyMode

Examples

• Fetch

Types

type Policy

type Policy struct {
	Version string `json:"version"`
	// The expected behavior of a sending MTA in the case of a policy validation
	// failure.
	Mode PolicyMode `json:"mode"`
	// Max lifetime of the policy, in seconds.
	MaxAge time.Duration `json:"max_age"`
	// One or more patterns matching the expected MX for this domain.
	MX []string `json:"mx"`
}

A Policy is a committment by the Policy Domain to support PKIX authenticated TLS for the specified MX hosts.

func Fetch

func Fetch(domain string) (*Policy, error)

Fetch retrieves the MTA STS policy for a domain. It returns a nil policy if no policy is available.

Example

policy, err := mtasts.Fetch("gmail.com")
if err != nil {
	log.Fatal(err)
}

log.Printf("%+v\n", policy)

type PolicyMode

type PolicyMode string

A PolicyMode describes the expected behavior of a sending MTA in the case of a policy validation failure.

const (
	// Sending MTAs treat STS policy failures as a mail delivery error, and MUST
	// NOT deliver the message to this host.
	ModeEnforce PolicyMode = "enforce"
	// Sending MTAs merely send a report indicating policy application failures.
	ModeReport = "report"
)