Struct DkimOutput 

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

The verification result of one DKIM1 signature.

MessageAuthenticator::verify_dkim returns one output per parsed DKIM-Signature header, plus a neutral output without a signature for each header rejected with an Error::Dkim error (such as an unsupported algorithm or version). Headers that fail to parse for other reasons, such as a missing tag or invalid base64, produce no output. Besides the DkimResult, it records the parsed signature (when the header could be parsed), the RFC 6651 failure report address and whether the result comes from an RFC 6541 ATPS check. Use From<DkimResult> and with_signature to synthesize an output, for example in tests or when feeding DMARC, which needs the signature’s d= domain for alignment.

Implementations

impl<'x> DkimOutput<'x>

pub fn with_signature(self, signature: &'x Signature) -> Self

Attaches the signature this result refers to.

Used to build an output outside the verifier, for example from a cached result, so that DMARC can check its d= domain for alignment.

pub fn result(&self) -> &DkimResult

Returns the verification result.

pub fn signature(&self) -> Option<&Signature>

Returns the parsed signature this result refers to, or None when the DKIM-Signature header could not be parsed.

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

Returns the address to send an RFC 6651 failure report to.

Set only when the signature has r=y, did not pass, the signer’s _report._domainkey.<d> record exists, the rp= sampling percentage selected this failure and the rr= tag requests reports for this kind of failure. The address is <ra>@<d>.

pub fn is_atps(&self) -> bool

Returns true when the result comes from an RFC 6541 ATPS check: the signature verified, its atps= domain matched the From domain and the ATPS record lookup determined the result.

Trait Implementations

impl<'x> Clone for DkimOutput<'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 DkimOutput<'x>

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

Formats the value using the given formatter.

impl<'x> Eq for DkimOutput<'x>

impl From<DkimResult> for DkimOutput<'_>

fn from(result: DkimResult) -> Self

Converts to this type from the input type.

impl<'x> PartialEq for DkimOutput<'x>

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

Equality operator ==.

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

Inequality operator !=.

impl<'x> StructuralPartialEq for DkimOutput<'x>