Struct Config 

pub struct Config {
    pub accounts: Vec<Account>,
    pub defaults: Defaults,
    pub trusted_senders: Vec<String>,
    pub classify: ClassifyConfig,
    pub guardrails: BTreeMap<String, String>,
}

Fields

accounts: Vec<Account>

defaults: Defaults

trusted_senders: Vec<String>

classify: ClassifyConfig

guardrails: BTreeMap<String, String>

Guardrails: action class -> “allow” | “confirm” | “deny”. Classes: send, delete, cancel, rsvp, bulk, unsubscribe.

Implementations

impl Config

pub const GUARDRAIL_CLASSES: [&'static str; 6]

Valid guardrail action classes.

pub const KNOWN_KEYS: &'static [&'static str]

Every settable config key, for pidge config show/help.

pub fn default_path() -> Result<PathBuf, CoreError>

Default path: ${XDG_CONFIG_HOME:-~/.config}/pidge/config.yaml.

pub fn load() -> Result<Self, CoreError>

Load the config from the default path. If the file doesn’t exist, returns Config::default().

pub fn load_from(path: &Path) -> Result<Self, CoreError>

Load from a specific path. Useful for tests.

pub fn save(&self) -> Result<(), CoreError>

Save the config to the default path.

pub fn save_to(&self, path: &Path) -> Result<(), CoreError>

Save to a specific path. Useful for tests.

pub fn add_account(&mut self, account: Account)

Add or replace an account by email. If this is the first account, also sets it as the default send AND default calendar account.

pub fn remove_account(&mut self, email: &str) -> Option<Account>

Remove an account by email. Returns the removed account. If the removed account was a default, that default is cleared.

pub fn set_default_send(&mut self, email: &str) -> Result<(), CoreError>

Set the default send account. Errors if the email isn’t a known signed-in account.

pub fn set_default_calendar(&mut self, email: &str) -> Result<(), CoreError>

Set the default calendar account. Errors if the email isn’t a known signed-in account.

pub fn find(&self, email: &str) -> Option<&Account>

Find an account by email.

pub fn add_trusted_sender(&mut self, email: &str)

Add an email to the trusted-senders list (case-insensitive). Idempotent.

pub fn remove_trusted_sender(&mut self, email: &str) -> bool

Remove an email from the trusted-senders list (case-insensitive). Returns true if it was present, false if it wasn’t (idempotent either way).

pub fn is_sender_trusted(&self, email: &str) -> bool

Case-insensitive check for whether an email is in the trusted-senders list.

pub fn get_key(&self, key: &str) -> Option<String>

Read a dotted config key as a display string, or None if unset.

pub fn set_key(&mut self, key: &str, value: &str) -> Result<(), CoreError>

Set a dotted config key from a string value. Errors on unknown key or unparseable value.

pub fn unset_key(&mut self, key: &str) -> Result<(), CoreError>

Revert a dotted config key to its unset/default state.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl PartialEq for Config

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config