Struct SpfParameters 

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

Input of an SPF check: the client IP, the identity to check and the values used for macro expansion.

Built with SpfParameters::helo, SpfParameters::mail_from, SpfParameters::helo_and_mail_from or SpfParameters::new, and passed to MessageAuthenticator::verify_spf or MessageAuthenticator::check_host, optionally wrapped in Parameters to supply a DNS cache.

Implementations

impl<'x> SpfParameters<'x>

pub fn helo( ip: IpAddr, helo_domain: &'x str, host_domain: &'x str, ) -> SpfParameters<'x>

Checks the HELO identity (RFC 7208, Section 2.3).

The SPF record of helo_domain is evaluated with <sender> set to postmaster@<helo_domain>. host_domain is the name of the host performing the check (the r macro).

pub fn mail_from( ip: IpAddr, helo_domain: &'x str, host_domain: &'x str, sender: &'x str, ) -> SpfParameters<'x>

Checks the MAIL FROM identity (RFC 7208, Section 2.4).

The SPF record of the domain of sender is evaluated; when sender has no @, helo_domain is used instead. An empty sender (null reverse-path) is replaced by postmaster@<domain>. host_domain is the name of the host performing the check (the r macro).

pub fn helo_and_mail_from( ip: IpAddr, helo_domain: &'x str, host_domain: &'x str, sender: &'x str, ) -> SpfParameters<'x>

Checks the HELO identity and then, unless it fails, the MAIL FROM identity.

Only MessageAuthenticator::verify_spf runs both checks; given to MessageAuthenticator::check_host, these parameters check the MAIL FROM identity alone. Arguments are those of SpfParameters::mail_from.

pub fn new( ip: IpAddr, domain: &'x str, helo_domain: &'x str, host_domain: &'x str, sender: &'x str, ) -> Self

Parameters for MessageAuthenticator::check_host.

• ip: the SMTP client IP address (<ip>).
• domain: the domain whose SPF record is evaluated (<domain>).
• helo_domain: the domain given in the HELO or EHLO command.
• host_domain: the name of the host performing the check (the r macro).
• sender: the MAIL FROM address (<sender>); an empty string is replaced by postmaster@<domain>.

Given to MessageAuthenticator::verify_spf, these parameters behave like SpfParameters::helo_and_mail_from and domain is ignored.

Trait Implementations

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

impl<'x> Debug for SpfParameters<'x>

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

Formats the value using the given formatter.

impl<'x> Eq for SpfParameters<'x>

impl<'x> From<SpfParameters<'x>> for Parameters<'x, SpfParameters<'x>, NoCache>

fn from(params: SpfParameters<'x>) -> Self

Converts to this type from the input type.

impl<'x> PartialEq for SpfParameters<'x>

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

Equality operator ==.

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

Inequality operator !=.

impl<'x> StructuralPartialEq for SpfParameters<'x>