Struct DkimSigner 

pub struct DkimSigner<T: SigningKey, State = NeedDomain> {
    pub key: T,
    pub template: Signature,
    /* private fields */
}

Fields

key: T

template: Signature

Implementations

impl<T: SigningKey> DkimSigner<T>

pub fn from_key(key: T) -> DkimSigner<T, NeedDomain>

impl<T: SigningKey> DkimSigner<T, NeedDomain>

pub fn domain(self, domain: impl Into<String>) -> DkimSigner<T, NeedSelector>

Sets the domain to use for signing.

impl<T: SigningKey> DkimSigner<T, NeedSelector>

pub fn selector(self, selector: impl Into<String>) -> DkimSigner<T, NeedHeaders>

Sets the selector to use for signing.

impl<T: SigningKey> DkimSigner<T, NeedHeaders>

pub fn headers( self, headers: impl IntoIterator<Item = impl Into<String>>, ) -> DkimSigner<T, Done>

Sets the headers to sign.

impl<T: SigningKey> DkimSigner<T, Done>

pub fn atps(self, atps: impl Into<String>) -> Self

Sets the third party signature.

pub fn atpsh(self, atpsh: HashAlgorithm) -> Self

Sets the third-party signature hashing algorithm.

pub fn agent_user_identifier(self, auid: impl Into<String>) -> Self

Sets the selector to use for signing.

pub fn expiration(self, expiration: u64) -> Self

Sets the number of seconds from now to use for the signature expiration.

pub fn body_length(self, body_length: bool) -> Self

Include the body length in the signature.

pub fn reporting(self, reporting: bool) -> Self

Request reports.

pub fn header_canonicalization(self, ch: Canonicalization) -> Self

Sets header canonicalization algorithm.

pub fn body_canonicalization(self, cb: Canonicalization) -> Self

Sets header canonicalization algorithm.

impl<T: SigningKey> DkimSigner<T, Done>

pub fn sign(&self, message: &[u8]) -> Result<Signature>

Signs a message.

pub fn sign_chained<'x>( &self, chunks: impl Iterator<Item = &'x [u8]>, ) -> Result<Signature>

Signs a chained message.

impl<T: SigningKey> DkimSigner<T, Done>

pub fn sign_streaming(&self) -> DkimSigningStream<'_, T>

Creates a streaming DKIM signer.

Feed raw message data via DkimSigningStream::write, then call DkimSigningStream::finish to get the signature.

Headers are buffered internally until the header/body boundary (\r\n\r\n) is detected. After that, body content is streamed through the hasher without additional buffering.

Example

let mut stream = signer.sign_streaming();
for chunk in message_chunks {
    stream.write(chunk);
}
let signature = stream.finish()?;

Trait Implementations

impl<T: Clone + SigningKey, State: Clone> Clone for DkimSigner<T, State>

fn clone(&self) -> DkimSigner<T, State>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + SigningKey, State: Debug> Debug for DkimSigner<T, State>

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

Formats the value using the given formatter.

impl<T: Default + SigningKey, State: Default> Default for DkimSigner<T, State>

fn default() -> DkimSigner<T, State>

Returns the “default value” for a type.

impl<T: PartialEq + SigningKey, State: PartialEq> PartialEq for DkimSigner<T, State>

fn eq(&self, other: &DkimSigner<T, State>) -> 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<T: Eq + SigningKey, State: Eq> Eq for DkimSigner<T, State>

impl<T: SigningKey, State> StructuralPartialEq for DkimSigner<T, State>