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
//! Unread mail. Only supports maildir format.
//!
//! Note that you need to enable `maildir` feature to use this block:
//! ```sh
//! cargo build --release --features maildir
//! ```
//!
//! # Configuration
//!
//! Key | Values | Default
//! ----|--------|--------
//! `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $status "`
//! `inboxes` | List of maildir inboxes to look for mails in. Supports path/glob expansions (e.g. `~` and `*`). | **Required**
//! `threshold_warning` | Number of unread mails where state is set to warning. | `1`
//! `threshold_critical` | Number of unread mails where state is set to critical. | `10`
//! `interval` | Update interval, in seconds. | `5`
//! `display_type` | Which part of the maildir to count: `"new"`, `"cur"`, or `"all"`. | `"new"`
//!
//! Placeholder | Value | Type | Unit
//! -------------|------------------------|--------|-----
//! `icon` | A static icon | Icon | -
//! `status` | Number of emails | Number | -
//!
//! # Examples
//!
//! ```toml
//! [[block]]
//! block = "maildir"
//! interval = 60
//! inboxes = ["~/mail/local", "~/maildir/account1/*"]
//! threshold_warning = 1
//! threshold_critical = 10
//! display_type = "new"
//! ```
//!
//! # Icons Used
//! - `mail`
use super::prelude::*;
use maildir::Maildir;
use std::path::PathBuf;
#[derive(Deserialize, Debug, SmartDefault)]
#[serde(deny_unknown_fields, default)]
pub struct Config {
pub format: FormatConfig,
#[default(5.into())]
pub interval: Seconds,
pub inboxes: Vec<String>,
#[default(1)]
pub threshold_warning: usize,
#[default(10)]
pub threshold_critical: usize,
#[default(MailType::New)]
pub display_type: MailType,
}
fn expand_inbox(inbox: &str) -> Result<impl Iterator<Item = PathBuf>> {
let expanded = shellexpand::full(inbox).error("Failed to expand inbox")?;
let paths = glob::glob(&expanded).error("Glob expansion failed")?;
Ok(paths.filter_map(|p| p.ok()))
}
pub async fn run(config: &Config, api: &CommonApi) -> Result<()> {
let format = config.format.with_default(" $icon $status ")?;
let mut inboxes = Vec::with_capacity(config.inboxes.len());
for inbox in &config.inboxes {
inboxes.extend(expand_inbox(inbox)?.map(Maildir::from));
}
loop {
let mut newmails = 0;
for inbox in &inboxes {
// TODO: spawn_blocking?
newmails += match config.display_type {
MailType::New => inbox.count_new(),
MailType::Cur => inbox.count_cur(),
MailType::All => inbox.count_new() + inbox.count_cur(),
};
}
let mut widget = Widget::new().with_format(format.clone());
widget.state = if newmails >= config.threshold_critical {
State::Critical
} else if newmails >= config.threshold_warning {
State::Warning
} else {
State::Idle
};
widget.set_values(map!(
"icon" => Value::icon("mail"),
"status" => Value::number(newmails)
));
api.set_widget(widget)?;
select! {
_ = sleep(config.interval.0) => (),
_ = api.wait_for_update_request() => (),
}
}
}
#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum MailType {
New,
Cur,
All,
}