API Reference MailAuth v#0.1.0

Copy Markdown View Source

Modules

Checks whether an email really came from who it says.

Writes and reads Authentication-Results: headers (RFC 8601).

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

DKIM signatures (RFC 6376), with the algorithm rules of RFC 8301 and Ed25519 keys (RFC 8463).

The result of checking one DKIM-Signature header.

DMARC (RFC 9989): checks that a DKIM signature or the SPF check that passed belongs to the domain in the From: address, and reads the policy the domain publishes.

A DMARC policy record (RFC 9989).

Reads DMARC aggregate reports (RFC 9990), as mail providers send them: XML, gzip or zip. Reports in the older RFC 7489 format read the same way.

The result of a DMARC check (RFC 9989).

The behaviour for DNS resolvers.

A resolver that wraps another one with an ETS cache.

A resolver that asks DNS servers with OTP's :inet_res.

A resolver that answers from a map, for tests and for checking mail offline.

SPF (RFC 7208): checks that the client IP may send mail for the MAIL FROM domain.

The result of an SPF check (RFC 7208).

Mix Tasks

Looks up the DMARC record that applies to a domain, where it was found, and the organizational domain.

Generates a DKIM key and prints the TXT record to publish.

Signs a message with DKIM and prints the signed message.

Checks whether an IP may send mail for a domain, and shows each record evaluated on the way through include and redirect.

Checks DKIM, SPF and DMARC of a message and prints every result.