dmarc

Documentation

Index

• Variables
• type AlignmentMode
• type FailureOption
• type PolicyType
• type Record
  • func LookupRecord(domain string) (*Record, error)
  • func LookupRecordWithSubdomainFallback(domain string) (*Record, error)
  • func ParseRecord(raw string) (*Record, error)
• type ReportFormat
• type ReportURI
• type TXTLookupFunc

Variables

var (
	ErrNoRecordFound   = errors.New("no record found")
	ErrDNSLookupFailed = errors.New("dns lookup failed")
)

Types

type AlignmentMode

type AlignmentMode string

const (
	AlignmentRelaxed AlignmentMode = "r" // relaxed
	AlignmentStrict  AlignmentMode = "s" // strict
)

type FailureOption

type FailureOption string

const (
	FailureAllFail  FailureOption = "0" // Report when all mechanisms fail with no aligned pass
	FailureAnyFail  FailureOption = "1" // Report when any mechanism fails to produce aligned pass
	FailureDKIMOnly FailureOption = "d" // Report when a DKIM signature fails evaluation
	FailureSPFOnly  FailureOption = "s" // Report when SPF evaluation fails
)

type PolicyType

type PolicyType string

const (
	PolicyNone       PolicyType = "none"
	PolicyQuarantine PolicyType = "quarantine"
	PolicyReject     PolicyType = "reject"
)

type Record

type Record struct {
	AggregateReportURI []ReportURI     // rua Aggregate report URIs
	AlignmentDKIM      AlignmentMode   // adkim DKIM alignment mode (r or s)
	AlignmentSPF       AlignmentMode   // aspf SPF alignment mode (r or s)
	ForensicReportURI  []ReportURI     // ruf Forensic report URIs (optional, deprecated)
	FailureOptions     []FailureOption // fo Forensic reporting options (optional, deprecated)
	Percent            int             // pct Percentage of messages to apply policy to
	Policy             PolicyType      // p Policy (none, quarantine, reject)
	ReportFormat       []ReportFormat  // rf Format for message-specific failure reports
	ReportInterval     uint32          // ri Interval for aggregate reports (seconds)
	SubdomainPolicy    PolicyType      // sp Subdomain policy
	Version            string          // v DMARC version, must be "DMARC1"
	// contains filtered or unexported fields
}

func LookupRecord

func LookupRecord(domain string) (*Record, error)

func LookupRecordWithSubdomainFallback

func LookupRecordWithSubdomainFallback(domain string) (*Record, error)

func ParseRecord

func ParseRecord(raw string) (*Record, error)

type ReportFormat

type ReportFormat string

ReportFormat represents the format requested for message-specific failure reports. Per RFC 7489 Section 6.3.8, only "afrf" is currently supported.

const (
	ReportFormatAFRF ReportFormat = "afrf" // Authentication Failure Reporting Format
)

type ReportURI

type ReportURI struct {
	URI     string // The report URI
	MaxSize int64  // Maximum size in bytes (0 means no limit)
}

ReportURI represents a DMARC URI with an optional size limit. Example: "mailto:reports@example.com!50m" (50 megabytes max) Per RFC 7489 Section 6.2 and 6.4.

type TXTLookupFunc

type TXTLookupFunc func(name string) ([]string, error)

var DefaultResolver TXTLookupFunc = net.LookupTXT

DefaultResolver is the default TXT lookup function.