Struct SpfBuilder

pub struct SpfBuilder { /* private fields */ }

Available on crate feature builder only.

The definition of the SpfBuilder struct which contains all information related a single SPF record.

Implementations

impl SpfBuilder

pub fn new() -> Self

Create a new empty SpfBuilder struct.

pub fn set_v1(&mut self) -> &mut Self

Set version to v=spf1

impl SpfBuilder

pub fn set_v2_pra(&mut self) -> &mut Self

Available on crate feature spf2 only.

Set version to spf2.0/pra

pub fn set_v2_mfrom(&mut self) -> &mut Self

Available on crate feature spf2 only.

Set version to spf2.0/mfrom

pub fn set_v2_pra_mfrom(&mut self) -> &mut Self

Available on crate feature spf2 only.

Set version to spf2.0/pra,mfrom

pub fn set_v2_mfrom_pra(&mut self) -> &mut Self

Available on crate feature spf2 only.

Set version to spf2.0/mfrom,pra

pub fn is_v2(&self) -> bool

Available on crate feature spf2 only.

Check that version is v2

impl SpfBuilder

pub fn version(&self) -> &String

Access the version attribute

pub fn clear_mechanism(&mut self, kind: Kind)

Clear the passed Kind which has been passed. Sets the passed mechanism to None

Note:

This method clears all associated Mechanism for the Kind provided.

Example:

use decon_spf::mechanism::{Qualifier, Kind, Mechanism};
use decon_spf::SpfBuilder;
let mut spf = SpfBuilder::new();
spf.set_v1();
spf.append_mechanism(Mechanism::all_with_qualifier(Qualifier::Pass));
spf.append_mechanism(Mechanism::a(Qualifier::Pass));
spf.append_mechanism(Mechanism::ip(Qualifier::Pass,
                                                 "203.32.160.0/23".parse().unwrap()));
// Remove ip4 Mechanism
spf.clear_mechanism(Kind::IpV4);

pub fn append_mechanism<T>(&mut self, mechanism: Mechanism<T>) -> &mut Self

where Self: Append<T>,

use decon_spf::mechanism::{Qualifier, Mechanism};
use decon_spf::SpfBuilder;
let mut spf = SpfBuilder::new();
spf.set_v1();
spf.append_mechanism(Mechanism::redirect(Qualifier::Pass,
                                "_spf.example.com").unwrap())
   .append_mechanism(Mechanism::all_with_qualifier(Qualifier::Pass));
assert!(spf.all().is_none());

Note

When Redirect is present, All will be set to None.

pub fn is_redirect(&self) -> bool

True if there is a redirect present in the spf record.

pub fn redirect(&self) -> Option<&Mechanism<String>>

Returns a reference to the Redirect Mechanism

pub fn includes(&self) -> Option<&Vec<Mechanism<String>>>

Returns a reference to the a Vec of Mechanism<String> for Include

pub fn a(&self) -> Option<&Vec<Mechanism<String>>>

Returns a reference to a Vec of Mechanism<String> for A

pub fn mx(&self) -> Option<&Vec<Mechanism<String>>>

Returns a reference to a Vec of Mechanism<String> for MX

pub fn ip4(&self) -> Option<&Vec<Mechanism<IpNetwork>>>

Returns a reference to a Vec of Mechanism<IpNetwork> for IP4

pub fn ip6(&self) -> Option<&Vec<Mechanism<IpNetwork>>>

Returns a reference to a Vec of Mechanism<IpNetwork> for IP6

pub fn exists(&self) -> Option<&Vec<Mechanism<String>>>

Returns a reference to a Vec of Mechanism<String> for Exists

pub fn ptr(&self) -> Option<&Mechanism<String>>

Returns a reference to a Vec of Mechanism<String> for Ptr

pub fn all(&self) -> Option<&Mechanism<All>>

Returns a reference to Mechanism<All> for All

pub fn build(self) -> Result<Spf<String>, SpfError>

Creates a Spf<String> from SpfBuilder

impl SpfBuilder

pub fn iter(&self) -> SpfBuilderIterator

Allows you to iterate over Mechanisms contained within the SPF record.

Note: Version string is not included.

Trait Implementations

impl Clone for SpfBuilder

fn clone(&self) -> SpfBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpfBuilder

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

Formats the value using the given formatter.

impl Default for SpfBuilder

fn default() -> SpfBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpfBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SpfBuilder

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

Formats the value using the given formatter.

impl From<Spf<String>> for SpfBuilder

Converts a Spf<String> into a SpfBuilder`struct.

fn from(source: Spf<String>) -> Self

Converts to this type from the input type.

impl FromStr for SpfBuilder

Creates an SpfBuilder struct by parsing a string representation of Spf.

Examples:

 use decon_spf::SpfBuilder;
 use decon_spf::SpfError;
 // Successful
 let input = "v=spf1 a mx -all";
 let spf: SpfBuilder = input.parse().unwrap();
 assert_eq!(spf.to_string(), input);

 // Additional Space between `A` and `MX`
 let invalid_input = "v=spf1 a   mx -all";
 let err: SpfError = invalid_input.parse::<SpfBuilder>().unwrap_err();
 assert_eq!(err, SpfError::WhiteSpaceSyntaxError);
 //  err.to_string() -> "Spf contains two or more consecutive whitespace characters.");

type Err = SpfError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for SpfBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SpfBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SpfBuilder