mtasts

package

v0.69.0 Latest Latest Go to latest Published: Oct 2, 2026 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dioad/net

Links

Open Source Insights

Documentation ¶

Overview ¶

Package mtasts provides types for building and serving an MTA-STS policy.

Index ¶

func FormatPolicy(p *Policy) (string, error)
func HTTPHandler(p *Policy) (http.HandlerFunc, error)
type Config
type Mode
type Policy
- func PolicyFromConfig(cfg Config) *Policy
type Record

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FormatPolicy ¶

func FormatPolicy(p *Policy) (string, error)

FormatPolicy https://www.mailhardener.com/kb/mta-sts TODO: use text/template for this stuff?

func HTTPHandler ¶

func HTTPHandler(p *Policy) (http.HandlerFunc, error)

HTTPHandler returns a handler serving p's policy document. p is a pointer, not a snapshot: the policy is rendered fresh on every request, so mutations made to *p after HTTPHandler returns (e.g. rotating MX hosts) are reflected on the next request.

Types ¶

type Config ¶

type Config struct {
	Mode   Mode     `mapstructure:"mode"`
	MX     []string `mapstructure:"mx"`
	MaxAge uint32   `mapstructure:"max-age"`
}

Config represents MTA-STS configuration used to create a policy.

type Mode ¶

type Mode string

Mode represents an MTA-STS mode (none, testing, enforce).

const (
	ModeNone    Mode = "none"
	ModeTesting Mode = "testing"
	ModeEnforce Mode = "enforce"
)

MTA-STS modes, per RFC 8461 section 3.

type Policy ¶

type Policy struct {
	Version string
	Mode    Mode
	MX      []string
	MaxAge  uint32
}

Policy represents an MTA-STS policy.

func PolicyFromConfig ¶

func PolicyFromConfig(cfg Config) *Policy

PolicyFromConfig builds a Policy from cfg, using the fixed "STSv1" version.

type Record ¶

type Record struct {
	Version string `mapstructure:"version"`
	ID      string `mapstructure:"id"`
}

Record represents an MTA-STS DNS TXT record.

func (*Record) RecordPrefix ¶

func (r *Record) RecordPrefix() string

RecordPrefix returns the DNS owner label prefix for an MTA-STS record, always "_mta-sts.".

func (*Record) RecordType ¶

func (r *Record) RecordType() string

RecordType returns the DNS record type string, "TXT".

func (*Record) RecordValue ¶

func (r *Record) RecordValue() string

RecordValue returns the wire-ready, quoted MTA-STS record value.

func (*Record) String ¶

func (r *Record) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL