Skip to main content

MailPaths

Struct MailPaths 

Source
pub struct MailPaths {
    pub notmuch: ResolvedConfig,
    pub mbsync: ResolvedConfig,
    pub msmtp: ResolvedConfig,
    pub notmuch_config: NotmuchConfig,
    pub mbsync_config: MbsyncConfig,
    pub msmtp_config: MsmtpConfig,
    pub maildir_root: PathBuf,
    pub database_path: PathBuf,
    pub binaries: Binaries,
    pub ecr_config_dir: PathBuf,
    pub ecr_state_dir: PathBuf,
    pub use_index: bool,
}

Fields§

§notmuch: ResolvedConfig§mbsync: ResolvedConfig§msmtp: ResolvedConfig§notmuch_config: NotmuchConfig§mbsync_config: MbsyncConfig§msmtp_config: MsmtpConfig§maildir_root: PathBuf§database_path: PathBuf§binaries: Binaries§ecr_config_dir: PathBuf

Where ecr keeps its own files, as opposed to the mail tools’ files.

§ecr_state_dir: PathBuf

The same split XDG draws: state is what ecr rewrites as it runs — the OAuth tokens and the mail index — as opposed to what the user edits.

§use_index: bool

Whether reads may be answered from the mail index. It is a cache of what notmuch holds, so turning it off costs speed and nothing else; the switch exists so a suspected disagreement can be settled without rebuilding or reinstalling anything.

Implementations§

Source§

impl MailPaths

Source

pub fn discover() -> Result<Self>

Source

pub fn with(env: &Env, settings: &ServerSettings) -> Result<Self>

Source

pub fn settings_file(&self) -> PathBuf

The user-facing settings file, shared by every client.

Source

pub fn oauth_profiles(&self) -> Profiles

The OAuth profiles, anchored to this Env rather than to the process.

Doctor reports on tokens, and reading one adopts it from oauthman’s directory — so resolving the store from dirs::config_dir() instead of from here made an integration test against a tempdir read, and write to, the developer’s real ~/.config/ecr. That is the same trap as NOTMUCH_CONFIG outranking a redirected HOME: isolation has to come from the one Env everything else already resolves through.

Source

pub fn themes_dir(&self) -> PathBuf

Where the shipped presets are seeded and the user’s own themes live.

Source

pub fn resolve_relative(&self, rel: &str) -> Result<PathBuf>

Resolves a path written in settings.toml against ecr’s own directory.

The link is user input that arrives over HTTP, so this is a boundary, not a convenience: anything that could climb out of ecr_config_dir or name a file ecr has no business reading is rejected rather than clamped. The check is lexical because the target need not exist yet — a theme can be pointed at before it is written.

Source

pub fn xapian_dir(&self) -> PathBuf

Source

pub fn post_new_hook(&self) -> Option<PathBuf>

Trait Implementations§

Source§

impl Clone for MailPaths

Source§

fn clone(&self) -> MailPaths

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MailPaths

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more