rspamd-client 0.7.0

Rspamd client API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Integration tests requiring a running Rspamd instance (see TESTING.md).

#[cfg(test)]
mod tests {
    use rspamd_client::config::{Config, EnvelopeData};

    const EMAIL: &str =
        "From: user@example.com\nTo: recipient@example.com\nSubject: Test\n\nThis is a test email.";

    fn encrypted_config() -> Config {
        // Rspamd config side:
        // keypair {
        //     privkey = "oqqm9kkt7c1ws638cyf41apar3in1wuyx647gzrx88hhd94ehm3y";
        //     id = "onztu3dmoms7i7panf5mdc6hqfb3dxore8etfpftmkcy85e6jr6pujn4fgskukjfa868oceoun485rcfrywk8ihug6g1i3b8g8aj8ay";
        //     pubkey = "k4nz984k36xmcynm1hr9kdbn6jhcxf4ggbrb1quay7f88rpm9kay";
        //     type = "kex";
        //     algorithm = "curve25519";
        //     encoding = "base32";
        // }
        Config::builder()
            .base_url("http://localhost:11333".to_string())
            .encryption_key("k4nz984k36xmcynm1hr9kdbn6jhcxf4ggbrb1quay7f88rpm9kay".to_string())
            .build()
    }

    fn envelope() -> EnvelopeData {
        EnvelopeData::builder()
            .from("ั‚ะตัั‚@example.com".to_string())
            .build()
    }

    #[cfg(feature = "sync")]
    #[test]
    fn test_sync_process() {
        let client = rspamd_client::RspamdSyncClient::new(encrypted_config()).unwrap();
        // One client, several sequential scans
        for _ in 0..3 {
            let response = client.scan(EMAIL, envelope()).unwrap();
            assert!(!response.symbols.is_empty());
        }
    }

    #[cfg(feature = "sync")]
    #[test]
    fn test_sync_one_shot_wrapper() {
        #[allow(deprecated)]
        let response = rspamd_client::scan_sync(&encrypted_config(), EMAIL, envelope()).unwrap();
        assert!(!response.symbols.is_empty());
    }

    #[cfg(feature = "async")]
    #[tokio::test]
    async fn test_async_encrypted_process() {
        let client = rspamd_client::RspamdAsyncClient::new(encrypted_config()).unwrap();
        // One client, several sequential scans over a pooled connection
        for _ in 0..3 {
            let response = client.scan(EMAIL, envelope()).await.unwrap();
            assert!(!response.symbols.is_empty());
        }
    }

    #[cfg(feature = "async")]
    #[tokio::test]
    async fn test_async_one_shot_wrapper() {
        #[allow(deprecated)]
        let response = rspamd_client::scan_async(&encrypted_config(), EMAIL, envelope())
            .await
            .unwrap();
        assert!(!response.symbols.is_empty());
    }

    #[cfg(feature = "sync")]
    #[test]
    fn test_sync_file_header() {
        // Test scanning with File header (local file path)
        // This requires Rspamd server to be on the same host and have access to the file
        let config = Config::builder()
            .base_url("http://localhost:11333".to_string())
            .build();
        let envelope = EnvelopeData::builder()
            .from("user@example.com".to_string())
            .file_path("/tmp/test_email.eml".to_string())
            .build();
        let client = rspamd_client::RspamdSyncClient::new(config).unwrap();
        // Body is not transmitted when file_path is set, but still required by API
        let _response = client.scan("", envelope).unwrap();
        // Test passes if no error is returned
    }

    #[cfg(feature = "async")]
    #[tokio::test]
    async fn test_async_file_header() {
        // Test scanning with File header (local file path)
        // This requires Rspamd server to be on the same host and have access to the file
        let config = Config::builder()
            .base_url("http://localhost:11333".to_string())
            .build();
        let envelope = EnvelopeData::builder()
            .from("user@example.com".to_string())
            .file_path("/tmp/test_email.eml".to_string())
            .build();
        let client = rspamd_client::RspamdAsyncClient::new(config).unwrap();
        // Body is not transmitted when file_path is set, but still required by API
        let _response = client.scan("", envelope).await.unwrap();
        // Test passes if no error is returned
    }
}