Struct AuthenticationResults 

pub struct AuthenticationResults<'x> { /* private fields */ }

An Authentication-Results header (RFC 8601) under construction.

Create one with new, naming the host that performed the checks (the authserv-id), then add the output of each verifier. Every result has a consuming with_* method for chaining and a set_* method that takes &mut self. Results are written in the order they are added. A header with no results is written as Authentication-Results: <authserv-id>; none.

The Display implementation renders the header value without the field name and without the trailing CRLF.

Example

use mail_auth::{
    AuthenticatedMessage, AuthenticationResults, MessageAuthenticator,
    headers::HeaderWriter, spf::verify::SpfParameters,
};

let authenticator = MessageAuthenticator::new_cloudflare_tls().unwrap();
let message = AuthenticatedMessage::parse(raw_message).unwrap();
let dkim = authenticator.verify_dkim(&message).await;
let spf_params = || {
    SpfParameters::mail_from(
        "192.0.2.10".parse().unwrap(),
        "mail.example.org",
        "mx.example.com",
        "sender@example.org",
    )
};
let spf = authenticator.verify_spf(spf_params()).await;

let header = AuthenticationResults::new("mx.example.com")
    .with_dkim_results(&dkim, message.first_from_address())
    .with_spf_result(&spf, &spf_params())
    .to_header();

Implementations

impl<'x> AuthenticationResults<'x>

pub fn new(hostname: &'x str) -> Self

Creates an empty header. hostname is the authserv-id (RFC 8601 Section 2.5): the name of the host that performed the checks.

pub fn with_dkim_results( self, dkim: &[DkimOutput<'_>], header_from: &str, ) -> Self

Adds one dkim entry per DKIM output. See set_dkim_result.

pub fn set_dkim_results(&mut self, dkim: &[DkimOutput<'_>], header_from: &str)

Adds one dkim entry per DKIM output. See set_dkim_result.

pub fn with_dkim_result(self, dkim: &DkimOutput<'_>, header_from: &str) -> Self

Adds a dkim or dkim-atps entry. See set_dkim_result.

pub fn set_dkim_result(&mut self, dkim: &DkimOutput<'_>, header_from: &str)

Adds a dkim entry (RFC 8601 Section 2.7.1) for one DKIM output.

The entry reports header.i (or header.d when the signature has no i= tag), header.s and header.b, the first eight Base64 characters of the signature (RFC 6008). An ATPS result (RFC 6541) is written as a dkim-atps entry and also reports header.from, taken from header_from, the RFC 5322 From address. header_from is ignored for other results.

pub fn with_dkim2_result(self, dkim2: &Dkim2Output<'_>) -> Self

Adds a dkim2 entry. See set_dkim2_result.

pub fn set_dkim2_result(&mut self, dkim2: &Dkim2Output<'_>)

Adds a dkim2 entry for the result of a DKIM2 chain verification.

The entry reports header.d (signing domain) and header.i (signature instance number) of the first link in the chain when the chain passed, or of the first link that did not pass otherwise. Both are omitted for a provisional verification.

pub fn with_spf_result( self, spf: &SpfOutput, params: &SpfParameters<'_>, ) -> Self

Adds an spf entry. See set_spf_result.

pub fn set_spf_result(&mut self, spf: &SpfOutput, params: &SpfParameters<'_>)

Adds an spf entry (RFC 8601 Section 2.7.2) for an SPF output.

params supplies the client IP, the HELO domain, the host domain and the MAIL FROM address. Pass the MAIL FROM address as received, empty for the null reverse-path (check_host substitutes postmaster@<domain> on its own); a substituted address would be reported instead of <>. The reported identity follows the identity that check_host evaluated: smtp.helo when the HELO identity produced the result, otherwise smtp.mailfrom (written as <> for the null reverse-path). A comment explaining the result, including the client IP address, precedes the property.

pub fn with_dmarc_result(self, dmarc: &DmarcOutput) -> Self

Adds a dmarc entry. See set_dmarc_result.

pub fn set_dmarc_result(&mut self, dmarc: &DmarcOutput)

Adds a dmarc entry for a DMARC output (RFC 9989).

The result is the best of the DKIM and SPF alignment results. The entry reports header.from (the RFC 5322 From domain) and policy.dmarc, the policy published by that domain (none, quarantine or reject).

pub fn with_iprev_result(self, iprev: &IprevOutput, remote_ip: IpAddr) -> Self

Adds an iprev entry. See set_iprev_result.

pub fn set_iprev_result(&mut self, iprev: &IprevOutput, remote_ip: IpAddr)

Adds an iprev entry (RFC 8601 Section 3) for an iprev output. remote_ip is the SMTP client address checked, reported as policy.iprev.

Trait Implementations

impl<'x> Clone for AuthenticationResults<'x>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'x> Debug for AuthenticationResults<'x>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for AuthenticationResults<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'x> Eq for AuthenticationResults<'x>

impl HeaderWriter for AuthenticationResults<'_>

fn write_header(&self, writer: &mut impl Writer)

Writes the complete header field, including the field name and the trailing CRLF, to writer.

fn to_header(&self) -> String

Returns the complete header field as a string, including the field name and the trailing CRLF. Invalid UTF-8 is replaced with U+FFFD.

impl<'x> PartialEq for AuthenticationResults<'x>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'x> StructuralPartialEq for AuthenticationResults<'x>