Struct EnvelopeData 

pub struct EnvelopeData {
    pub from: Option<String>,
    pub rcpt: Vec<String>,
    pub ip: Option<String>,
    pub user: Option<String>,
    pub helo: Option<String>,
    pub hostname: Option<String>,
    pub file_path: Option<String>,
    pub body_block: bool,
    pub additional_headers: HashMap<String, String>,
}

Fields

from: Option<String>

Sender email address

rcpt: Vec<String>

Recipients email addresses

ip: Option<String>

Optional IP address of the sender

user: Option<String>

Optional IP of the sender

helo: Option<String>

Optional HELO string

hostname: Option<String>

Optional hostname

file_path: Option<String>

Optional file path for local file scanning (File header) When set, the message body is not transmitted and Rspamd reads the file directly from disk This is a significant optimization when client and server are on the same host

body_block: bool

Request rewritten body in response (body_block flag) When enabled, if Rspamd rewrites the message body, it will be returned as a separate part of the reply after the JSON, with Message-Offset header indicating where the body starts

additional_headers: HashMap<String, String>

Optional additional headers

Implementations

impl EnvelopeData

pub fn builder() -> EnvelopeDataBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building EnvelopeData. On the builder, call .from(...)(optional), .rcpt(...)(optional), .ip(...)(optional), .user(...)(optional), .helo(...)(optional), .hostname(...)(optional), .file_path(...)(optional), .body_block(...)(optional), .additional_headers(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of EnvelopeData.

Trait Implementations

impl Debug for EnvelopeData

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

Formats the value using the given formatter.

impl Default for EnvelopeData

fn default() -> EnvelopeData

Returns the “default value” for a type.

impl IntoIterator for EnvelopeData

fn into_iter(self) -> Self::IntoIter

Convert the EnvelopeData struct into an iterator

type Item = (String, String)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, String>

Which kind of iterator are we turning this into?

impl PartialEq for EnvelopeData

fn eq(&self, other: &EnvelopeData) -> 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 StructuralPartialEq for EnvelopeData