Sovite.DMARC.Result (sovite v0.6.0)

Copy Markdown View Source

The outcome of Sovite.DMARC.check/3.

  • result - :pass if SPF or DKIM passed with an aligned domain, :fail if neither did, :none without a policy, :temperror on a DNS error, and :permerror for a From domain that is not a domain name.
  • disposition - what the policy asks for this message, after sampling. Always :none unless result is :fail.
  • applied - which policy tag gave the disposition on :fail: :p for the domain that published the record, :sp for a subdomain, :np for a subdomain that does not exist.
  • sampled - whether the failing message was selected by pct= (and the record is not in testing mode), so the disposition is the one published. When false, it is one step milder.
  • dkim_domain - the d= of the first passing, aligned DKIM signature.
  • reason - a human-readable note, for logs and reports.

Summary

Types

t()

Types

t()

@type t() :: %Sovite.DMARC.Result{
  applied: :p | :sp | :np | nil,
  disposition: Sovite.DMARC.Record.policy(),
  dkim_aligned: boolean(),
  dkim_domain: String.t() | nil,
  from_domain: String.t(),
  policy: Sovite.DMARC.Policy.t() | nil,
  reason: String.t() | nil,
  result: :pass | :fail | :none | :temperror | :permerror,
  sampled: boolean(),
  spf_aligned: boolean()
}