Struct Retention 

pub struct Retention { /* private fields */ }

Retention policy configuration for email messages.

A retention policy defines how old messages should be before they are subject to retention actions (trash/delete), and whether a label should be automatically generated to categorize messages matching this policy.

Examples

use cull_gmail::{Retention, MessageAge};

// Create a retention policy for messages older than 6 months
let policy = Retention::new(MessageAge::Months(6), true);

// Create a retention policy without auto-generated labels
let policy = Retention::new(MessageAge::Years(1), false);

Implementations

impl Retention

pub fn new(age: MessageAge, generate_label: bool) -> Self

Create a new retention policy.

Arguments

• age - The message age threshold for this retention policy
• generate_label - Whether to automatically generate a label for messages matching this policy

Examples

use cull_gmail::{Retention, MessageAge};

// Policy for messages older than 30 days with auto-generated label
let policy = Retention::new(MessageAge::Days(30), true);

// Policy for messages older than 1 year without label generation
let policy = Retention::new(MessageAge::Years(1), false);

pub fn age(&self) -> &MessageAge

Get the message age threshold for this retention policy.

Examples

use cull_gmail::{Retention, MessageAge};

let policy = Retention::new(MessageAge::Days(30), true);
assert_eq!(policy.age(), &MessageAge::Days(30));

pub fn generate_label(&self) -> bool

Check if this retention policy should generate automatic labels.

When true, messages matching this retention policy will be automatically tagged with a generated label based on the age specification.

Examples

use cull_gmail::{Retention, MessageAge};

let policy = Retention::new(MessageAge::Days(30), true);
assert_eq!(policy.generate_label(), true);

let policy = Retention::new(MessageAge::Days(30), false);
assert_eq!(policy.generate_label(), false);

pub fn set_generate_label(&mut self, generate_label: bool)

Set whether this retention policy should generate automatic labels.

Examples

use cull_gmail::{Retention, MessageAge};

let mut policy = Retention::new(MessageAge::Days(30), false);
policy.set_generate_label(true);
assert_eq!(policy.generate_label(), true);

Trait Implementations

impl Clone for Retention

fn clone(&self) -> Retention

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Retention

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

Formats the value using the given formatter.

impl Default for Retention

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Retention

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Retention

fn eq(&self, other: &Retention) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Retention

impl StructuralPartialEq for Retention