Struct SpfOutput 

pub struct SpfOutput { /* private fields */ }

The outcome of an SPF check.

Returned by MessageAuthenticator::verify_spf and MessageAuthenticator::check_host. Besides the SpfResult, it carries the checked domain, the explanation string of a fail result and the RFC 6652 report address, when the record requests a report for this result. SpfOutput::new and SpfOutput::with_result build a synthetic output, for example to feed DMARC with a result obtained elsewhere.

Implementations

impl SpfOutput

pub fn new(domain: String) -> Self

Creates an output for domain with result SpfResult::None, no explanation and no report address.

pub fn with_result(self, result: SpfResult) -> Self

Sets the result.

pub fn with_report(self, spf: &SpfRecord) -> Self

Sets the report address to <ra>@<domain> when spf has an ra= modifier, its rr= bitmask covers the current result and the message is sampled by rp= (RFC 6652, Section 3). Call it after SpfOutput::with_result; a pass result never produces a report.

pub fn with_explanation(self, explanation: String) -> Self

Sets the explanation string (RFC 7208, Section 6.2).

pub fn result(&self) -> SpfResult

Returns the SPF result.

pub fn domain(&self) -> &str

Returns the domain that was checked: the HELO domain or the domain of the MAIL FROM address.

pub fn explanation(&self) -> Option<&str>

Returns the expanded exp= explanation, set only on a fail result whose record has an exp= modifier that resolved.

pub fn report_address(&self) -> Option<&str>

Returns the address that requested an authentication failure report for this result (RFC 6652), if any.

Trait Implementations

impl Clone for SpfOutput

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 SpfOutput

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

Formats the value using the given formatter.

impl Default for SpfOutput

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SpfOutput

impl PartialEq for SpfOutput

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

Equality operator ==.

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

Inequality operator !=.