Struct vsmtp_server::Connection

pub struct Connection<S> where
    S: AsyncRead + AsyncWrite + Send + Unpin + Debug, {
    pub kind: ConnectionKind,
    pub server_name: String,
    pub timestamp: SystemTime,
    pub is_alive: bool,
    pub config: Arc<Config>,
    pub client_addr: SocketAddr,
    pub server_addr: SocketAddr,
    pub error_count: i64,
    pub is_secured: bool,
    pub is_authenticated: bool,
    pub authentication_attempt: i64,
    pub inner: AbstractIO<S>,
}

Instance containing connection to the server’s information

Fields

kind: ConnectionKind

server’s port

server_name: String

server’s domain of the connection, (from config.server.domain or sni)

timestamp: SystemTime

connection timestamp

is_alive: bool

is still alive

config: Arc<Config>

server’s configuration

client_addr: SocketAddr

peer socket address

server_addr: SocketAddr

address used for this connection

error_count: i64

number of error the client made so far

is_secured: bool

is under tls (tunneled or opportunistic)

is_authenticated: bool

has completed SASL challenge (AUTH)

authentication_attempt: i64

number of time the AUTH command has been received (and failed)

inner: AbstractIO<S>

inner stream

Implementations

impl<S> Connection<S> where
    S: AsyncRead + AsyncWrite + Send + Unpin + Debug, 

pub fn new(
    kind: ConnectionKind,
    client_addr: SocketAddr,
    server_addr: SocketAddr,
    config: Arc<Config>,
    inner: S
) -> Self

pub fn new_with(
    kind: ConnectionKind,
    server_name: String,
    timestamp: SystemTime,
    config: Arc<Config>,
    client_addr: SocketAddr,
    server_addr: SocketAddr,
    error_count: i64,
    is_secured: bool,
    is_authenticated: bool,
    authentication_attempt: i64,
    inner: S
) -> Self

impl<S> Connection<S> where
    S: AsyncRead + AsyncWrite + Send + Unpin + Debug, 

pub async fn send_reply_or_code(
    &mut self,
    reply_or_code: ReplyOrCodeID
) -> Result<()>

Errors

• see Connection::send_code and Connection::send_reply

pub async fn send_code(&mut self, code_id: CodeID) -> Result<()>

Errors

pub async fn send_reply(&mut self, reply: Reply) -> Result<()>

send a reply code to the client

Errors

pub async fn send(&mut self, reply: &str) -> Result<()>

Send a buffer

Errors

• internal connection writer error

pub async fn read(&mut self, timeout: Duration) -> Result<Option<String>>

Read a line from the client

Errors

• timed-out
• internal connection reader error

impl<S> Connection<S> where
    S: AsyncRead + AsyncWrite + Send + Unpin + Sync + Debug, 

pub async fn receive<M>(
    &mut self,
    tls_config: Option<Arc<ServerConfig>>,
    rsasl: Option<Arc<Mutex<Backend>>>,
    rule_engine: Arc<RuleEngine>,
    resolvers: Arc<Resolvers>,
    mail_handler: &mut M
) -> Result<()> where
    M: OnMail + Send, 

Receives the incomings mail of a connection

Errors

• server failed to send a message
• a transaction failed
• the pre-queue processing of the mail failed

Trait Implementations

impl<S> Debug for Connection<S> where
    S: AsyncRead + AsyncWrite + Send + Unpin + Debug, 

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

Formats the value using the given formatter.