Struct RspamdAsyncClient 

pub struct RspamdAsyncClient { /* private fields */ }

Persistent asynchronous Rspamd client.

Owns the underlying reqwest::Client, so TCP (and TLS, when enabled) connections are pooled and reused across calls, unlike the one-shot scan_async wrapper which pays a fresh connection setup on every call.

Cheap to clone (reqwest::Client is internally reference-counted and the configuration is shared through an Arc); Send + Sync + 'static, so it is suitable for stashing in a static or an LRU cache keyed by Config.

use rspamd_client::config::Config;
use rspamd_client::RspamdAsyncClient;

let config = Config::builder()
    .base_url("http://localhost:11333".to_string())
    .build();
let client = RspamdAsyncClient::new(config)?;
for email in ["first message", "second message"] {
    let reply = client.scan(email, Default::default()).await?;
    println!("action: {}", reply.action);
}

Implementations

impl RspamdAsyncClient

pub fn new(config: Config) -> Result<Self, RspamdError>

Create a persistent client from a configuration.

pub fn config(&self) -> &Config

The configuration this client was built from.

pub async fn scan<B: AsRef<[u8]> + Send>( &self, body: B, envelope_data: EnvelopeData, ) -> Result<RspamdScanReply, RspamdError>

Scan an email, returning the parsed scan reply.

pub async fn learn_spam<B: AsRef<[u8]> + Send>( &self, body: B, envelope_data: EnvelopeData, ) -> Result<RspamdLearnReply, RspamdError>

Learn an email as spam (requires the controller endpoint and password).

pub async fn learn_ham<B: AsRef<[u8]> + Send>( &self, body: B, envelope_data: EnvelopeData, ) -> Result<RspamdLearnReply, RspamdError>

Learn an email as ham (requires the controller endpoint and password).

pub async fn fuzzy_add<B: AsRef<[u8]> + Send>( &self, body: B, envelope_data: EnvelopeData, ) -> Result<RspamdLearnReply, RspamdError>

Add an email to fuzzy storage; pass Flag/Weight via EnvelopeData::additional_headers.

pub async fn fuzzy_del<B: AsRef<[u8]> + Send>( &self, body: B, envelope_data: EnvelopeData, ) -> Result<RspamdLearnReply, RspamdError>

Remove an email from fuzzy storage; pass Flag via EnvelopeData::additional_headers.

Trait Implementations

impl Clone for RspamdAsyncClient

fn clone(&self) -> RspamdAsyncClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.