cull-gmail 0.1.8

Cull emails from a gmail account using the gmail 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
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
use std::fmt::Display;

use crate::{Error, Result};

/// Message age specification for retention policies.
///
/// Defines different time periods that can be used to specify how old messages
/// should be before they are subject to retention actions (trash/delete).
///
/// # Examples
///
/// ```
/// use cull_gmail::MessageAge;
///
/// // Create different message age specifications
/// let days = MessageAge::Days(30);
/// let weeks = MessageAge::Weeks(4);
/// let months = MessageAge::Months(6);
/// let years = MessageAge::Years(2);
///
/// // Use with retention policy
/// println!("Messages older than {} will be processed", months);
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum MessageAge {
    /// Number of days to retain the message
    ///
    /// # Example
    /// ```
    /// use cull_gmail::MessageAge;
    /// let age = MessageAge::Days(30);
    /// assert_eq!(age.to_string(), "d:30");
    /// ```
    Days(i64),
    /// Number of weeks to retain the message
    ///
    /// # Example
    /// ```
    /// use cull_gmail::MessageAge;
    /// let age = MessageAge::Weeks(4);
    /// assert_eq!(age.to_string(), "w:4");
    /// ```
    Weeks(i64),
    /// Number of months to retain the message
    ///
    /// # Example
    /// ```
    /// use cull_gmail::MessageAge;
    /// let age = MessageAge::Months(6);
    /// assert_eq!(age.to_string(), "m:6");
    /// ```
    Months(i64),
    /// Number of years to retain the message
    ///
    /// # Example
    /// ```
    /// use cull_gmail::MessageAge;
    /// let age = MessageAge::Years(2);
    /// assert_eq!(age.to_string(), "y:2");
    /// ```
    Years(i64),
}

impl Display for MessageAge {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            MessageAge::Days(v) => write!(f, "d:{v}"),
            MessageAge::Weeks(v) => write!(f, "w:{v}"),
            MessageAge::Months(v) => write!(f, "m:{v}"),
            MessageAge::Years(v) => write!(f, "y:{v}"),
        }
    }
}

impl MessageAge {
    /// Create a new `MessageAge` from a period string and count.
    ///
    /// # Arguments
    ///
    /// * `period` - The time period ("days", "weeks", "months", "years")
    /// * `count` - The number of time periods (must be positive)
    ///
    /// # Examples
    ///
    /// ```
    /// use cull_gmail::MessageAge;
    ///
    /// let age = MessageAge::new("days", 30).unwrap();
    /// assert_eq!(age, MessageAge::Days(30));
    ///
    /// let age = MessageAge::new("months", 6).unwrap();
    /// assert_eq!(age, MessageAge::Months(6));
    ///
    /// // Invalid period returns an error
    /// assert!(MessageAge::new("invalid", 1).is_err());
    ///
    /// // Negative count returns an error
    /// assert!(MessageAge::new("days", -1).is_err());
    /// ```
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - The period string is not recognized
    /// - The count is negative or zero
    pub fn new(period: &str, count: i64) -> Result<Self> {
        if count <= 0 {
            return Err(Error::InvalidMessageAge(format!(
                "Count must be positive, got: {count}"
            )));
        }

        match period.to_lowercase().as_str() {
            "days" => Ok(MessageAge::Days(count)),
            "weeks" => Ok(MessageAge::Weeks(count)),
            "months" => Ok(MessageAge::Months(count)),
            "years" => Ok(MessageAge::Years(count)),
            _ => Err(Error::InvalidMessageAge(format!(
                "Unknown period '{period}', expected one of: days, weeks, months, years"
            ))),
        }
    }

    /// Parse a `MessageAge` from a string representation (e.g., "d:30", "m:6").
    ///
    /// # Arguments
    ///
    /// * `s` - String in format "`period:count`" where period is d/w/m/y
    ///
    /// # Examples
    ///
    /// ```
    /// use cull_gmail::MessageAge;
    ///
    /// let age = MessageAge::parse("d:30").unwrap();
    /// assert_eq!(age, MessageAge::Days(30));
    ///
    /// let age = MessageAge::parse("y:2").unwrap();
    /// assert_eq!(age, MessageAge::Years(2));
    ///
    /// // Invalid format returns None
    /// assert!(MessageAge::parse("invalid").is_none());
    /// assert!(MessageAge::parse("d").is_none());
    /// ```
    #[must_use]
    pub fn parse(s: &str) -> Option<MessageAge> {
        let bytes = s.as_bytes();
        if bytes.len() < 3 || bytes[1] != b':' {
            return None;
        }

        let period = bytes[0];
        let count_str = &s[2..];
        let count = count_str.parse::<i64>().ok()?;

        if count <= 0 {
            return None;
        }

        match period {
            b'd' => Some(MessageAge::Days(count)),
            b'w' => Some(MessageAge::Weeks(count)),
            b'm' => Some(MessageAge::Months(count)),
            b'y' => Some(MessageAge::Years(count)),
            _ => None,
        }
    }

    /// Generate a label string for this message age.
    ///
    /// This creates a standardized label that can be used to categorize
    /// messages based on their retention period.
    ///
    /// # Examples
    ///
    /// ```
    /// use cull_gmail::MessageAge;
    ///
    /// let age = MessageAge::Days(30);
    /// assert_eq!(age.label(), "retention/30-days");
    ///
    /// let age = MessageAge::Years(1);
    /// assert_eq!(age.label(), "retention/1-years");
    /// ```
    #[must_use]
    pub fn label(&self) -> String {
        match self {
            MessageAge::Days(v) => format!("retention/{v}-days"),
            MessageAge::Weeks(v) => format!("retention/{v}-weeks"),
            MessageAge::Months(v) => format!("retention/{v}-months"),
            MessageAge::Years(v) => format!("retention/{v}-years"),
        }
    }

    /// Get the numeric value of this message age.
    ///
    /// # Examples
    ///
    /// ```
    /// use cull_gmail::MessageAge;
    ///
    /// let age = MessageAge::Days(30);
    /// assert_eq!(age.value(), 30);
    ///
    /// let age = MessageAge::Years(2);
    /// assert_eq!(age.value(), 2);
    /// ```
    #[must_use]
    pub fn value(&self) -> i64 {
        match self {
            MessageAge::Days(v)
            | MessageAge::Weeks(v)
            | MessageAge::Months(v)
            | MessageAge::Years(v) => *v,
        }
    }

    /// Get the period type as a string.
    ///
    /// # Examples
    ///
    /// ```
    /// use cull_gmail::MessageAge;
    ///
    /// let age = MessageAge::Days(30);
    /// assert_eq!(age.period_type(), "days");
    ///
    /// let age = MessageAge::Years(2);
    /// assert_eq!(age.period_type(), "years");
    /// ```
    #[must_use]
    pub fn period_type(&self) -> &'static str {
        match self {
            MessageAge::Days(_) => "days",
            MessageAge::Weeks(_) => "weeks",
            MessageAge::Months(_) => "months",
            MessageAge::Years(_) => "years",
        }
    }
}

impl TryFrom<&str> for MessageAge {
    type Error = Error;

    /// Try to create a `MessageAge` from a string using the parse format.
    ///
    /// # Examples
    ///
    /// ```
    /// use cull_gmail::MessageAge;
    /// use std::convert::TryFrom;
    ///
    /// let age = MessageAge::try_from("d:30").unwrap();
    /// assert_eq!(age, MessageAge::Days(30));
    ///
    /// let age = MessageAge::try_from("invalid");
    /// assert!(age.is_err());
    /// ```
    fn try_from(value: &str) -> Result<Self> {
        Self::parse(value).ok_or_else(|| {
            Error::InvalidMessageAge(format!("Failed to parse MessageAge from '{value}'"))
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_message_age_new_valid() {
        // Test valid periods
        assert_eq!(MessageAge::new("days", 30).unwrap(), MessageAge::Days(30));
        assert_eq!(MessageAge::new("weeks", 4).unwrap(), MessageAge::Weeks(4));
        assert_eq!(MessageAge::new("months", 6).unwrap(), MessageAge::Months(6));
        assert_eq!(MessageAge::new("years", 2).unwrap(), MessageAge::Years(2));

        // Test case insensitive
        assert_eq!(MessageAge::new("DAYS", 1).unwrap(), MessageAge::Days(1));
        assert_eq!(MessageAge::new("Days", 1).unwrap(), MessageAge::Days(1));
        assert_eq!(MessageAge::new("dAyS", 1).unwrap(), MessageAge::Days(1));
    }

    #[test]
    fn test_message_age_new_invalid_period() {
        assert!(MessageAge::new("invalid", 1).is_err());
        assert!(MessageAge::new("day", 1).is_err()); // singular form
        assert!(MessageAge::new("", 1).is_err());

        // Check error messages
        let err = MessageAge::new("invalid", 1).unwrap_err();
        assert!(err.to_string().contains("Unknown period 'invalid'"));
    }

    #[test]
    fn test_message_age_new_invalid_count() {
        assert!(MessageAge::new("days", 0).is_err());
        assert!(MessageAge::new("days", -1).is_err());
        assert!(MessageAge::new("days", -100).is_err());

        // Check error messages
        let err = MessageAge::new("days", -1).unwrap_err();
        assert!(err.to_string().contains("Count must be positive"));
    }

    #[test]
    fn test_message_age_parse_valid() {
        assert_eq!(MessageAge::parse("d:30").unwrap(), MessageAge::Days(30));
        assert_eq!(MessageAge::parse("w:4").unwrap(), MessageAge::Weeks(4));
        assert_eq!(MessageAge::parse("m:6").unwrap(), MessageAge::Months(6));
        assert_eq!(MessageAge::parse("y:2").unwrap(), MessageAge::Years(2));

        // Test large numbers
        assert_eq!(MessageAge::parse("d:999").unwrap(), MessageAge::Days(999));
    }

    #[test]
    fn test_message_age_parse_invalid() {
        // Invalid format
        assert!(MessageAge::parse("invalid").is_none());
        assert!(MessageAge::parse("d").is_none());
        assert!(MessageAge::parse("d:").is_none());
        assert!(MessageAge::parse(":30").is_none());
        assert!(MessageAge::parse("x:30").is_none());

        // Invalid count
        assert!(MessageAge::parse("d:0").is_none());
        assert!(MessageAge::parse("d:-1").is_none());
        assert!(MessageAge::parse("d:abc").is_none());

        // Wrong separator
        assert!(MessageAge::parse("d-30").is_none());
        assert!(MessageAge::parse("d 30").is_none());
    }

    #[test]
    fn test_message_age_display() {
        assert_eq!(MessageAge::Days(30).to_string(), "d:30");
        assert_eq!(MessageAge::Weeks(4).to_string(), "w:4");
        assert_eq!(MessageAge::Months(6).to_string(), "m:6");
        assert_eq!(MessageAge::Years(2).to_string(), "y:2");
    }

    #[test]
    fn test_message_age_label() {
        assert_eq!(MessageAge::Days(30).label(), "retention/30-days");
        assert_eq!(MessageAge::Weeks(4).label(), "retention/4-weeks");
        assert_eq!(MessageAge::Months(6).label(), "retention/6-months");
        assert_eq!(MessageAge::Years(2).label(), "retention/2-years");
    }

    #[test]
    fn test_message_age_value() {
        assert_eq!(MessageAge::Days(30).value(), 30);
        assert_eq!(MessageAge::Weeks(4).value(), 4);
        assert_eq!(MessageAge::Months(6).value(), 6);
        assert_eq!(MessageAge::Years(2).value(), 2);
    }

    #[test]
    fn test_message_age_period_type() {
        assert_eq!(MessageAge::Days(30).period_type(), "days");
        assert_eq!(MessageAge::Weeks(4).period_type(), "weeks");
        assert_eq!(MessageAge::Months(6).period_type(), "months");
        assert_eq!(MessageAge::Years(2).period_type(), "years");
    }

    #[test]
    fn test_message_age_clone() {
        let original = MessageAge::Days(30);
        let cloned = original.clone();
        assert_eq!(original, cloned);
    }

    #[test]
    fn test_message_age_eq() {
        assert_eq!(MessageAge::Days(30), MessageAge::Days(30));
        assert_ne!(MessageAge::Days(30), MessageAge::Days(31));
        assert_ne!(MessageAge::Days(30), MessageAge::Weeks(30));
    }

    #[test]
    fn test_parse_roundtrip() {
        let original = MessageAge::Days(30);
        let serialized = original.to_string();
        let parsed = MessageAge::parse(&serialized).unwrap();
        assert_eq!(original, parsed);

        let original = MessageAge::Years(5);
        let serialized = original.to_string();
        let parsed = MessageAge::parse(&serialized).unwrap();
        assert_eq!(original, parsed);
    }

    #[test]
    fn test_try_from() {
        use std::convert::TryFrom;

        assert_eq!(MessageAge::try_from("d:30").unwrap(), MessageAge::Days(30));
        assert_eq!(MessageAge::try_from("w:4").unwrap(), MessageAge::Weeks(4));
        assert_eq!(MessageAge::try_from("m:6").unwrap(), MessageAge::Months(6));
        assert_eq!(MessageAge::try_from("y:2").unwrap(), MessageAge::Years(2));

        assert!(MessageAge::try_from("invalid").is_err());
        assert!(MessageAge::try_from("d:-1").is_err());
    }
}