daaki-imap 0.2.0

An IMAP4rev1/IMAP4rev2 async client library
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

use super::*;

#[test]
fn system_flags_round_trip() {
    let flags = [
        Flag::Seen,
        Flag::Answered,
        Flag::Flagged,
        Flag::Deleted,
        Flag::Draft,
        Flag::Recent,
    ];
    for flag in &flags {
        let s = flag.as_imap_str();
        let parsed = Flag::from_imap_str(s);
        assert_eq!(*flag, parsed);
    }
}

#[test]
fn case_insensitive_parsing() {
    assert_eq!(Flag::from_imap_str("\\SEEN"), Flag::Seen);
    assert_eq!(Flag::from_imap_str("\\seen"), Flag::Seen);
    assert_eq!(Flag::from_imap_str("\\Seen"), Flag::Seen);
}

#[test]
fn custom_flag_preserved() {
    let flag = Flag::from_imap_str("$Important");
    assert_eq!(flag, Flag::Custom("$Important".into()));
}

// ===== Spec audit: failing tests for known deviations =====

#[test]
fn spec_audit_l1_permanent_flag_wildcard_has_dedicated_variant() {
    // RFC 3501 Section 7.1: `flag-perm = flag / "\*"` — the wildcard
    // means "client can create new keywords." It deserves a dedicated
    // variant (e.g. Flag::Wildcard) rather than falling through to
    // Flag::Custom("\\*").
    let flag = Flag::from_imap_str("\\*");
    assert!(
        !matches!(flag, Flag::Custom(_)),
        "\\* should have a dedicated Flag variant, not Flag::Custom; got {flag:?}"
    );
    assert_eq!(flag, Flag::Wildcard);
}

#[test]
fn wildcard_round_trip() {
    // RFC 3501 Section 7.1: `flag-perm = flag / "\*"`
    let flag = Flag::Wildcard;
    let wire = flag.as_imap_str();
    assert_eq!(wire, "\\*");
    let parsed = Flag::from_imap_str(wire);
    assert_eq!(parsed, Flag::Wildcard);
}

// ===== Case-insensitive Custom flag equality (RFC 3501 Section 2.3.2) =====

#[test]
fn custom_flag_equality_is_case_insensitive() {
    // RFC 3501 Section 2.3.2: "A flag can be permanent or session-only…
    // Flag names are case-insensitive."
    assert_eq!(
        Flag::Custom("$Important".into()),
        Flag::Custom("$important".into()),
        "Custom flags must compare case-insensitively per RFC 3501 Section 2.3.2"
    );
    assert_eq!(
        Flag::Custom("$JUNK".into()),
        Flag::Custom("$Junk".into()),
        "Custom flags must compare case-insensitively per RFC 3501 Section 2.3.2"
    );
}

#[test]
fn custom_flag_hash_is_case_insensitive() {
    // RFC 3501 Section 2.3.2: Flag names are case-insensitive, so
    // case-different Custom flags must hash to the same bucket.
    use std::collections::HashSet;

    let mut set = HashSet::new();
    set.insert(Flag::Custom("$Important".into()));
    // Inserting the same flag in different case should not grow the set.
    set.insert(Flag::Custom("$important".into()));
    assert_eq!(
        set.len(),
        1,
        "Case-insensitively equal Custom flags must have the same Hash per RFC 3501 Section 2.3.2"
    );
}

// ===== RFC 3501 Section 2.3.2 audit: cross-representation equality =====

#[test]
fn custom_seen_equals_seen_variant() {
    // RFC 3501 Section 2.3.2: "Flag names are case-insensitive."
    // Custom("\\Seen") represents the same flag as Flag::Seen.
    assert_eq!(
        Flag::Custom("\\Seen".into()),
        Flag::Seen,
        "Custom(\"\\\\Seen\") must equal Flag::Seen per RFC 3501 Section 2.3.2"
    );
}

#[test]
fn custom_system_flag_cross_representation_hash() {
    // RFC 3501 Section 2.3.2: equal flags must hash identically.
    use std::collections::HashSet;
    let mut set = HashSet::new();
    set.insert(Flag::Seen);
    set.insert(Flag::Custom("\\Seen".into()));
    assert_eq!(
        set.len(),
        1,
        "Custom(\"\\\\Seen\") and Flag::Seen must hash the same per RFC 3501 Section 2.3.2"
    );
}

#[test]
fn custom_wildcard_equals_wildcard_variant() {
    // RFC 3501 Section 7.1: permanent flag wildcard.
    assert_eq!(
        Flag::Custom("\\*".into()),
        Flag::Wildcard,
        "Custom(\"\\\\*\") must equal Flag::Wildcard per RFC 3501 Section 7.1"
    );
}

// ===== From<String> and From<&str> (RFC 3501 Section 2.3.2) =====

#[test]
fn from_str_known_system_flag() {
    // RFC 3501 Section 2.3.2: system flags.
    assert_eq!(Flag::from("\\Seen"), Flag::Seen);
    assert_eq!(Flag::from("\\Answered"), Flag::Answered);
    assert_eq!(Flag::from("\\Flagged"), Flag::Flagged);
    assert_eq!(Flag::from("\\Deleted"), Flag::Deleted);
    assert_eq!(Flag::from("\\Draft"), Flag::Draft);
    assert_eq!(Flag::from("\\Recent"), Flag::Recent);
    assert_eq!(Flag::from("\\*"), Flag::Wildcard);
}

#[test]
fn from_string_known_system_flag() {
    // RFC 3501 Section 2.3.2: system flags via owned String.
    assert_eq!(Flag::from("\\Seen".to_owned()), Flag::Seen);
    assert_eq!(Flag::from("\\Flagged".to_owned()), Flag::Flagged);
}

#[test]
fn from_str_case_insensitive() {
    // RFC 3501 Section 2.3.2: flag names are case-insensitive.
    assert_eq!(Flag::from("\\SEEN"), Flag::Seen);
    assert_eq!(Flag::from("\\seen"), Flag::Seen);
    assert_eq!(Flag::from("\\DRAFT"), Flag::Draft);
}

#[test]
fn from_str_custom_flag() {
    // RFC 3501 Section 2.3.2: keyword flags.
    assert_eq!(Flag::from("$Custom"), Flag::Custom("$Custom".to_owned()));
    assert_eq!(
        Flag::from("$Important"),
        Flag::Custom("$Important".to_owned())
    );
}