Struct AccountConfig 

pub struct AccountConfig {

    pub name: String,
    pub email: String,
    pub display_name: Option<String>,
    pub signature: Option<String>,
    pub signature_delim: Option<String>,
    pub downloads_dir: Option<PathBuf>,
    pub folder: Option<FolderConfig>,
    pub envelope: Option<EnvelopeConfig>,
    pub flag: Option<FlagConfig>,
    pub message: Option<MessageConfig>,
    pub template: Option<TemplateConfig>,
    pub sync: Option<SyncConfig>,
    pub pgp: Option<PgpConfig>,
}

The user’s account configuration.

It represents everything that the user can customize for a given account. It is the main configuration used by all other modules. Usually, it serves as a reference for building config file structure.

Fields

name: String

The name of the user account.

The account name is used as an unique identifier for a given configuration.

email: String

The email address of the user account.

display_name: Option<String>

The display name of the user.

It usually corresponds to the full name of the user.

signature: Option<String>

The email signature of the user.

It can be either a path to a file (usually ~/.signature) or a raw string.

signature_delim: Option<String>

The email signature delimiter of the user signature.

Defaults to -- \n.

downloads_dir: Option<PathBuf>

The downloads directory.

It is mostly used for downloading messages attachments. Defaults to the system temporary directory (usually /tmp).

folder: Option<FolderConfig>

The folder configuration.

envelope: Option<EnvelopeConfig>

The envelope configuration.

flag: Option<FlagConfig>

The flag configuration.

message: Option<MessageConfig>

The message configuration.

template: Option<TemplateConfig>

The message configuration.

sync: Option<SyncConfig>

The account synchronization configuration.

pgp: Option<PgpConfig>

The PGP configuration.

Implementations

impl AccountConfig

pub fn find_full_signature(&self) -> Option<String>

Get the signature, including the delimiter.

Uses the default delimiter -- \n in case no delimiter has been defined. Return None if no signature has been defined.

pub fn get_downloads_dir(&self) -> PathBuf

Get then expand the downloads directory path.

Falls back to dirs::download_dir.

pub fn get_download_file_path( &self, downloads_dir: Option<&Path>, path: impl AsRef<Path>, ) -> Result<PathBuf>

Build the downloadable version of the given path.

The aim of this helper is to build a safe download path for a given path.

First, only the file name of the give path is taken in order to prevent any interaction outside of the downloads directory.

Then, a suffix may be added to the final path if it already exists on the filesystem in order to prevent any overriding or data loss.

pub fn is_sync_enabled(&self) -> bool

Return true if the synchronization is enabled.

pub fn does_sync_dir_exist(&self) -> bool

Return true if the synchronization directory already exists.

pub async fn exec_received_envelope_hook(&self, envelope: &Envelope)

Execute the envelope received hook.

pub async fn exec_any_envelope_hook(&self, envelope: &Envelope)

Execute the envelope any hook.

pub async fn exec_envelope_hook(&self, hook: &WatchHook, envelope: &Envelope)

Execute the given envelope hook.

pub fn find_folder_alias(&self, from_name: &str) -> Option<String>

Find the alias of the given folder name.

The alias is also shell expanded.

pub fn get_folder_alias(&self, folder: &str) -> String

Find the alias of the given folder, otherwise return the given folder itself.

pub fn get_inbox_folder_alias(&self) -> String

Get the inbox folder alias.

pub fn get_sent_folder_alias(&self) -> String

Get the sent folder alias.

pub fn get_drafts_folder_alias(&self) -> String

Get the drafts folder alias.

pub fn get_trash_folder_alias(&self) -> String

Get the trash folder alias.

pub fn is_trash_folder(&self, folder: &str) -> bool

Return true if the given folder matches the Trash folder.

pub fn is_delete_message_style_flag(&self) -> bool

Return true if the delete message style matches the flag-based message deletion style.

pub fn get_folder_aliases(&self) -> Option<&HashMap<String, String>>

Get all folder aliases.

pub fn find_folder_kind_from_alias(&self, alias: &str) -> Option<FolderKind>

Find the folder kind associated to the given folder alias.

This function is the reverse of [get_folder_alias], as it tries to find a key (folder kind) matching the given value (folder alias).

pub fn get_envelope_list_page_size(&self) -> usize

Get the envelope listing page size if defined, otherwise return the default one.

pub fn get_envelope_thread_page_size(&self) -> usize

Get the envelope threading page size if defined, otherwise return the default one.

pub fn get_message_read_format(&self) -> EmailTextPlainFormat

Get the message reading format if defined, otherwise return the default one.

pub fn get_message_read_headers(&self) -> Vec<String>

Get the message reading headers if defined, otherwise return the default ones.

pub fn get_message_write_headers(&self) -> Vec<String>

Get the message writing headers if defined, otherwise return the default ones.

pub fn find_message_pre_send_hook(&self) -> Option<&Command>

Find the message pre-send hook.

pub fn should_save_copy_sent_message(&self) -> bool

Return true if a copy of sent messages should be saved in the sent folder.

pub fn generate_tpl_interpreter(&self) -> MimeInterpreterBuilder

Generate a template interpreter with prefilled options from the current user account configuration.

pub fn get_envelope_list_datetime_fmt(&self) -> String

Get the envelope listing datetime format, otherwise return the default one.

pub fn has_envelope_list_datetime_local_tz(&self) -> bool

Return true if the envelope listing datetime local timezone option is enabled.

pub fn get_new_template_signature_style(&self) -> NewTemplateSignatureStyle

Get the new template signature placement.

pub fn get_reply_template_signature_style(&self) -> ReplyTemplateSignatureStyle

pub fn get_reply_template_posting_style(&self) -> ReplyTemplatePostingStyle

pub fn get_reply_template_quote_headline( &self, msg: &Message<'_>, ) -> Option<String>

pub fn get_forward_template_signature_style( &self, ) -> ForwardTemplateSignatureStyle

pub fn get_forward_template_posting_style(&self) -> ForwardTemplatePostingStyle

pub fn get_forward_template_quote_headline(&self) -> String

Trait Implementations

impl Clone for AccountConfig

fn clone(&self) -> AccountConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountConfig

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

Formats the value using the given formatter.

impl Default for AccountConfig

fn default() -> AccountConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AccountConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a AccountConfig> for Address<'a>

fn from(config: &'a AccountConfig) -> Self

Converts to this type from the input type.

impl PartialEq for AccountConfig

fn eq(&self, other: &AccountConfig) -> 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 Serialize for AccountConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AccountConfig

impl StructuralPartialEq for AccountConfig