Struct decon_spf::Spf

pub struct Spf { /* fields omitted */ }

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

Implementations

impl Spf

pub fn new() -> Self

Create a new empty Spf struct.

pub fn is_valid(&self) -> bool

Check that the source string was parsed and was valid. Check that data stored in the Spf Struct is considered a valid Spf Record.

pub fn has_warnings(&self) -> bool

This is supported on crate feature warn-dns only.

Check if there were any warnings when parsing the Spf String. This can only be changed to true when warn-dns feature has been eabled. Other wise it will always be false

pub fn set_v1(&mut self)

Set version to v=spf1

pub fn set_v2_pra(&mut self)

Set version to spf2.0/pra

pub fn set_v2_mfrom(&mut self)

Set version to spf2.0/mfrom

pub fn set_v2_pra_mfrom(&mut self)

Set version to spf2.0/pra,mfrom

pub fn set_v2_mfrom_pra(&mut self)

Set version to spf2.0/mfrom,pra

pub fn is_v1(&self) -> bool

Check that version is v1

pub fn is_v2(&self) -> bool

Check that version is v2

pub fn version(&self) -> &String

Return a reference to version

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 assocated Mechanism for the Kind provided.

Example:

use decon_spf::mechanism::{Qualifier, Kind, Mechanism};
use decon_spf::Spf;
let mut new_spf_record = Spf::new();
new_spf_record.set_v1();
new_spf_record.append_mechanism(Mechanism::new_all(Qualifier::Pass));
new_spf_record.append_mechanism(Mechanism::new_a_without_mechanism(Qualifier::Pass));
new_spf_record.append_ip_mechanism(Mechanism::new_ip(Qualifier::Pass,
                                                     "203.32.160.0/23".parse().unwrap()));
assert_eq!(new_spf_record.to_string(), "v=spf1 a ip4:203.32.160.0/23 all".to_string());
// Remove ip4 Mechanism
new_spf_record.clear_mechanism(Kind::IpV4);
assert_eq!(new_spf_record.to_string(), "v=spf1 a all".to_string());

pub fn append_mechanism(&mut self, mechanism: Mechanism<String>)

Appends the passed Mechanism<String> to the SPF struct. This only works for Mechanism which are NOT ip4: or ip6:

Example:

use decon_spf::mechanism::{Qualifier, Mechanism};
use decon_spf::Spf;
let mut new_spf_record = Spf::new();
new_spf_record.set_v1();
new_spf_record.append_mechanism(Mechanism::new_redirect(Qualifier::Pass,
                                "_spf.example.com".to_string()));
new_spf_record.append_mechanism(Mechanism::new_all(Qualifier::Pass));
assert_eq!(new_spf_record.to_string(), "v=spf1 redirect=_spf.example.com".to_string());

Note:

If the Spf is already set as Redirect trying to append an All Mechanism will have no affect.

pub fn append_ip_mechanism(&mut self, mechanism: Mechanism<IpNetwork>)

Appends the passed Mechanism<IpNetwork> to the SPF struct.

Example:

use decon_spf::mechanism::{Qualifier, Mechanism};
use decon_spf::Spf;
let mut new_spf_record = Spf::new();
new_spf_record.set_v1();
new_spf_record.append_ip_mechanism(Mechanism::new_ip(Qualifier::Pass,
                                "203.32.160.0/23".parse().unwrap()));
new_spf_record.append_mechanism(Mechanism::new_all(Qualifier::Pass));
assert_eq!(new_spf_record.to_string(), "v=spf1 ip4:203.32.160.0/23 all".to_string());

pub fn try_validate(&mut self) -> Result<(), SpfError>

👎 Deprecated:

This is expected to be depreciated.

Note: Experimential

Do not use. Very rudementary validation check.

• Will fail if the length of source is more than MAX_SPF_STRING_LENGTH characters See: SourceLengthExceeded
• Will fail if there are more than 10 DNS lookups. Looks are required for each A, MX , Redirect, and Include Mechanism. See: LookupLimitExceeded (This will change given new information)

pub fn as_spf(&self) -> Result<String, SpfError>

👎 Deprecated since 0.2.0:

This has been deprecated. Use to_string() instead.

Returns a new string representation of the spf record if possible. This does not use the source attribute.

pub fn source(&self) -> &String

Returns a reference to the string stored in source

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 the a Vec of Mechanism<String> for A

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

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

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

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

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

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

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

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

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

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

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

Returns a reference to Mechanism<String> for All

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

This is supported on crate feature warn-dns only.

Return a reference to the list of domains that gave warnings.

Trait Implementations

impl Debug for Spf

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

Formats the value using the given formatter.

impl Default for Spf

fn default() -> Self

Returns the “default value” for a type.

impl Display for Spf

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

Formats the value using the given formatter.

impl FromStr for Spf

Creates an Spf Struct by parsing a string representation of Spf.

Examples:

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

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

 // Example with warn-dns feature enabled.
 // Spf contains an invalid DNS host entry
 let bad_spf2: Spf = "v=spf1 a mx:example.m/24 -all".parse().unwrap();
 // Note: `warn-dns` will check `example.m` ignoring `/24`
 #[cfg(feature = "warn-dns")]
 assert_eq!(bad_spf2.has_warnings(), true);
 #[cfg(feature = "warn-dns")]
 assert_eq!(bad_spf2.warnings().unwrap()[0], "example.m/24");

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 TryFrom<&'_ str> for Spf

type Error = SpfError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.