MailAuth.AuthenticationResults.Method (MailAuth v0.1.0)

Copy Markdown View Source

One method's result in an Authentication-Results: header, such as dkim=pass header.d=example.com.

Fields:

  • :method: the method name, lowercase, such as "dkim", "spf" or "dmarc". Unknown methods are kept
  • :version: the method version, when written (dkim/1=pass)
  • :result: :pass, :fail, :softfail, :neutral, :none, :temperror, :permerror, :policy or :hardfail, or the text as written when it is none of these
  • :reason: the reason= text
  • :properties: the other properties, such as %{"header.d" => "example.com"}, with lowercase names

Summary

Types

t()

@type t() :: %MailAuth.AuthenticationResults.Method{
  method: String.t(),
  properties: %{required(String.t()) => String.t()},
  reason: String.t() | nil,
  result: atom() | String.t(),
  version: String.t() | nil
}