MailAuth.Result (MailAuth v0.1.0)

Copy Markdown View Source

The result of MailAuth.authenticate/2.

Fields:

  • :from_domain: the domain of the From: address, or nil when there is not exactly one
  • :dkim: one MailAuth.DKIM.Result per signature
  • :spf: the MailAuth.SPF.Result. Without a client IP it is :none, reason :no_client_ip
  • :dmarc: the MailAuth.DMARC.Result, or nil with dmarc: false
  • :warnings: the warnings of all the checks, without repeats

Summary

Types

t()

Functions

dmarc_pass?(result)

True only when DMARC passed: a DKIM signature or the SPF check that passed belongs to the From: domain.

Types

t()

@type t() :: %MailAuth.Result{
  dkim: [MailAuth.DKIM.Result.t()],
  dmarc: MailAuth.DMARC.Result.t() | nil,
  from_domain: String.t() | nil,
  spf: MailAuth.SPF.Result.t() | nil,
  warnings: [atom()]
}

Functions

dmarc_pass?(result)

@spec dmarc_pass?(t()) :: boolean()

True only when DMARC passed: a DKIM signature or the SPF check that passed belongs to the From: domain.

This is the one call most callers need.