Struct DmarcOutput 

pub struct DmarcOutput { /* private fields */ }

The outcome of DMARC evaluation.

Returned by MessageAuthenticator::verify_dmarc. It holds the Author Domain, the policy to apply, the aligned SPF and DKIM results and the DMARC Policy Record that was applied, if any.

Implementations

impl DmarcOutput

pub fn domain(&self) -> &str

Returns the Author Domain (the RFC5322.From domain, as an A-label), or an empty string when none could be determined.

pub fn into_domain(self) -> String

Consumes the output and returns the Author Domain.

pub fn policy(&self) -> Policy

Returns the policy to apply to a failing message: p, sp or np of the applied record depending on where it was found, lowered by one level in test mode (t=y). Policy::None when DMARC does not apply.

pub fn dkim_result(&self) -> &DmarcResult

Returns the DKIM alignment result: Pass when a passing DKIM (or DKIM2 instance 1) signature is aligned, Fail when signatures passed but none aligned, TempError on a DNS error affecting an aligned identifier, None when no signature passed.

pub fn spf_result(&self) -> &DmarcResult

Returns the SPF alignment result: Pass when SPF passed for an aligned MAIL FROM domain, Fail when SPF passed but the domain is not aligned, TempError when SPF returned temperror for an aligned domain or alignment hit a DNS error, None otherwise.

pub fn result(&self) -> DmarcResult

Returns the overall DMARC result: the best of the SPF and DKIM results, ranked Pass, TempError, PermError, Fail. When both are None, returns Fail with Error::NotAligned if a record was applied and None otherwise.

pub fn record(&self) -> Option<&Arc<DmarcRecord>>

Returns the DMARC Policy Record that was applied, if any.

pub fn requests_reports(&self) -> bool

Returns true when the applied record has a rua= or ruf= tag with at least one destination.

pub fn failure_report(&self) -> Option<FailureOptions>

Returns the fo= options of the applied record when a failure report (RFC 9991) should be sent for this message: the record has ruf= destinations, the result is not a temporary error, and the failed mechanisms match fo=. Returns None otherwise.

Trait Implementations

impl Clone for DmarcOutput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DmarcOutput

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

Formats the value using the given formatter.

impl Default for DmarcOutput

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DmarcOutput

impl PartialEq for DmarcOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DmarcOutput