Enum vsmtp_common::Context

pub enum Context {
    Connect(ContextConnect),
    Helo(ContextHelo),
    MailFrom(ContextMailFrom),
    RcptTo(ContextRcptTo),
    Finished(ContextFinished),
}

A step-by-step SMTP envelop produced by the transaction

Variants

Connect(ContextConnect)

See Stage::Connect

Helo(ContextHelo)

See Stage::Helo

MailFrom(ContextMailFrom)

See Stage::MailFrom

RcptTo(ContextRcptTo)

See Stage::RcptTo

Finished(ContextFinished)

See Stage::Finished

Implementations

impl Context

pub fn stage(&self) -> Stage

Get the current SMTP stage of the transaction

pub fn reset(&mut self)

Called when a “RSET” is issued

pub fn new( client_addr: SocketAddr, server_addr: SocketAddr, server_name: Domain, timestamp: OffsetDateTime, uuid: Uuid ) -> Self

Convert the context to a [ContextConnect]

pub fn to_helo( &mut self, client_name: ClientName, using_deprecated: bool ) -> Result<&mut Self, Error>

Convert the context to a [ContextHelo] or overwrite the existing one

Errors

• state if not Stage::Helo or Stage::MailFrom

pub fn with_credentials( &mut self, credentials: Credentials ) -> Result<(), Error>

Set the credentials used by the client during the SASL handshake

Errors

• state if not Stage::Helo or Stage::MailFrom

pub fn to_mail_from( &mut self, reverse_path: Option<Address> ) -> Result<(), Error>

Convert the context to a [ContextMailFrom] or overwrite the existing one

Errors

• state if not Stage::Helo or Stage::MailFrom

pub fn to_finished(&mut self) -> Result<(), Error>

Convert the context to a [ContextFinished]

Errors

• state if not Stage::RcptTo

pub fn set_skipped(&mut self, status: Status)

pub fn connection_timestamp(&self) -> &OffsetDateTime

Get the timestamp of the TCP/IP connection

pub fn connection_uuid(&self) -> &Uuid

Get the uuid of the TCP/IP connection

pub fn client_addr(&self) -> &SocketAddr

Get the address of the socket client

pub fn server_addr(&self) -> &SocketAddr

Get the address of the socket server which accepted the connection

pub fn server_name(&self) -> &Domain

Get the name of the server which the client connected to.

pub fn is_secured(&self) -> bool

Is the connection been encrypted using the SMTP+TLS protocol?

pub fn is_authenticated(&self) -> bool

Is the connection been authenticated using the SMTP+SASL protocol?

pub fn to_secured( &mut self, sni: Option<Domain>, protocol_version: ProtocolVersion, cipher_suite: CipherSuite, peer_certificates: Option<Vec<Certificate>>, alpn_protocol: Option<Vec<u8>> ) -> Result<(), Error>

Set the TlsProperties of the connection.

Errors

• state if not Stage::Connect or Stage::Helo

pub fn client_name(&self) -> Result<&ClientName, Error>

Get the name of the client.

Errors

• state if not Stage::Helo or after

pub fn tls(&self) -> &Option<TlsProperties>

Get the TlsProperties of the connection.

pub fn auth(&self) -> &Option<AuthProperties>

Get the AuthProperties of the connection.

pub fn auth_mut(&mut self) -> Option<&mut AuthProperties>

Get the mutable reference AuthProperties of the connection.

pub fn to_auth(&mut self) -> Result<&mut AuthProperties, Error>

Set the AuthProperties of the connection.

Errors

• state if not Stage::Connect or Stage::Helo

pub fn reverse_path(&self) -> Result<&Option<Address>, Error>

Get the reverse path.

Errors

• state if not Stage::MailFrom or after

pub fn set_reverse_path( &mut self, reverse_path: Option<Address> ) -> Result<(), Error>

Set the reverse path.

Errors

• state if not Stage::MailFrom or after

pub fn mail_timestamp(&self) -> Result<&OffsetDateTime, Error>

Get the time::OffsetDateTime when the MAIL FROM has been received.

Errors

• state if not Stage::MailFrom or after

pub fn message_uuid(&self) -> Result<&Uuid, Error>

Get the message id

Errors

• state if not Stage::MailFrom or after

pub fn generate_message_id(&mut self) -> Result<(), Error>

Generate a new message id in the context

Errors

• state if not Stage::MailFrom or after

pub fn add_forward_path( &mut self, forward_path: Address, transport: Arc<dyn AbstractTransport> ) -> Result<(), Error>

Add a recipient at the end of the list of forward paths. If the state was Stage::MailFrom, the state is changed to Stage::RcptTo.

Errors

• state if not Stage::MailFrom or after

pub fn remove_forward_path( &mut self, forward_path: &Address ) -> Result<bool, Error>

Remove the first recipient with the address forward_path. Return false if no such recipient exist

Errors

• state if not Stage::RcptTo or after

pub fn forward_paths(&self) -> Result<&Vec<Address>, Error>

Get a reference of the forwards path.

Errors

• state if not Stage::RcptTo or after

pub fn forward_paths_mut(&mut self) -> Result<&mut Vec<Address>, Error>

Get a mutable reference of the forwards path.

Errors

• state if not Stage::RcptTo or after

pub fn set_transport_for_one( &mut self, search: &Address, transport: Arc<dyn AbstractTransport> ) -> Result<(), Error>

Set a delivery transport for a recipients.

Errors

• state if not Stage::RcptTo or after

pub fn set_transport_foreach( &mut self, transport: Arc<dyn AbstractTransport> ) -> Result<(), Error>

Set a delivery transport for all recipients.

Errors

• state if not Stage::RcptTo or after

pub fn delivery(&self) -> Result<&HashMap<WrapperSerde, DeliverTo>, Error>

Errors

• state if not Stage::RcptTo or after

pub fn delivery_mut( &mut self ) -> Result<&mut HashMap<WrapperSerde, DeliverTo>, Error>

Errors

• state if not Stage::RcptTo or after

pub fn transaction_type(&self) -> Result<&TransactionType, Error>

Get the TransactionType.

Errors

• state if not Stage::RcptTo or after

pub fn set_transaction_type( &mut self, transaction_type: TransactionType ) -> Result<(), Error>

Set the TransactionType. If the state was Stage::MailFrom, the state is changed to Stage::RcptTo.

Errors

• state if not Stage::MailFrom or after

pub fn spf(&self) -> Result<Option<&Result>, Error>

Get the spf::Result.

Errors

• state if not Stage::Finished

pub fn set_spf(&mut self, spf: Result) -> Result<(), Error>

Set the spf::Result.

Errors

• state if not Stage::Finished

pub fn dkim(&self) -> Result<Option<&VerificationResult>, Error>

Get the dkim::VerificationResult if it exists.

Errors

• state if not Stage::Finished

pub fn set_dkim(&mut self, result: VerificationResult) -> Result<(), Error>

Set the dkim::VerificationResult.

Errors

• state if not Stage::Finished

pub fn unwrap_finished(self) -> Result<ContextFinished, Error>

Convert the instance into a [ContextFinished].

Errors

• state if not Stage::Finished

Trait Implementations

impl Clone for Context

fn clone(&self) -> Context

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Context

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

Formats the value using the given formatter.

impl Serialize for Context

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

Serialize this value into the given Serde serializer.