Struct Account 

pub struct Account {

    pub id: String,
    pub kind: AccountKind,
    pub enabled: bool,
    pub address: Option<String>,
    pub maildir: Option<String>,
    pub url: Option<String>,
    pub site: Option<String>,
    pub realtime: bool,
    pub muted: bool,
    pub background: Option<bool>,
    pub microphone: Option<bool>,
    pub camera: Option<bool>,
    pub screen: Option<bool>,
    pub categories: Vec<String>,
    pub announced_by: Vec<String>,
    pub area: Option<String>,
    pub trusted_authserv_ids: Vec<String>,
    pub host: Option<String>,
    pub port: Option<u16>,
    pub security: Security,
    pub username: Option<String>,
    pub sync_days: Option<u32>,
    pub auth: Option<String>,
    pub skip_folders: Vec<String>,
    pub history_weeks: Option<u32>,
    pub priority: Priority,
    pub name: Option<String>,
    pub smtp_host: Option<String>,
    pub smtp_port: Option<u16>,
    pub smtp_security: Security,
    pub signature: Option<String>,
    pub fetch_minutes: Option<u32>,
    pub shield: bool,
    pub shield_ai: bool,
}

Fields

id: String

kind: AccountKind

enabled: bool

Switched off in Accounts: kept with its settings, neither synced nor shown.

address: Option<String>

maildir: Option<String>

Where this account’s mail is kept on disk (Maildir); see Account::maildir_path.

url: Option<String>

For portals: the address of the web mailbox.

site: Option<String>

For portals, what the site is: “mailbox” (a secure mailbox), “chat”, “dating”, “other”.

realtime: bool

For portals: its notifications shown at once, not at your pace.

muted: bool

For portals: its sounds silenced.

background: Option<bool>

For portals: kept open while the window is, to receive its notifications.

microphone: Option<bool>

For portals: the microphone, the camera, sharing the screen, for calls; unsaid, as its kind goes (chats, video calls and dating sites have them).

camera: Option<bool>

screen: Option<bool>

categories: Vec<String>

For portals: your own categories, any words (“Banque”, “Santé”): the list filters by them.

announced_by: Vec<String>

For portals: the domains whose mail says something waits there (“you have a new message in your secure mailbox”); the site’s own domain when unsaid.

area: Option<String>

“personal” for an address, or a site, of yours outside work: it stays in view in quiet time.

trusted_authserv_ids: Vec<String>

The authserv-id your provider writes in Authentication-Results (RFC 8601).

host: Option<String>

The IMAP server, found from the address when the account is added.

port: Option<u16>

security: Security

username: Option<String>

The login, when it is not the address.

sync_days: Option<u32>

How many days of mail the first sync brings.

auth: Option<String>

How it signs in: “google” for Google’s OAuth (its tokens in the keyring); a password otherwise.

skip_folders: Vec<String>

Folders not kept here, by their server names: they stay on the server only.

history_weeks: Option<u32>

How far back this account’s mail reaches, in weeks, 0 for everything; the configuration’s history_weeks when unset.

priority: Priority

How its mail ranks against the other accounts’.

name: Option<String>

Your name as the From line shows it.

smtp_host: Option<String>

The SMTP submission server, found from the address when first needed.

smtp_port: Option<u16>

smtp_security: Security

signature: Option<String>

Added below what you write, in Markdown.

fetch_minutes: Option<u32>

Minutes between two fetches of this account, when it should come more or less often than the rest.

shield: bool

A public address that may bring hostile mail: its mail is read first, held, and summarised (shield).

shield_ai: bool

For a shielded account, an AI may read its new mail to say its tone and topic (docs/ai.md).

Implementations

impl Account

pub fn history_days(&self) -> Option<i64>

How far back this account’s mail reaches, in days; None for everything.

pub fn imap( id: &str, address: &str, host: &str, port: u16, security: Security, username: Option<&str>, ) -> Account

A mail account fetched over IMAP; username only when it differs from the address.

pub fn maildir_path(&self) -> PathBuf

The Maildir of this account: maildir if set, else ~/.local/share/sioul/mail/<id>.

pub fn login(&self) -> Option<&str>

The name to log in with: username, else the address.

pub fn port_or_default(&self) -> u16

The port to use: port, else the usual one for the encryption.

pub fn smtp_port_or_default(&self) -> u16

The SMTP port to use: smtp_port, else the usual one for the encryption (RFC 8314).

pub fn syncs(&self) -> bool

Whether Sioul fetches this account’s mail itself.

pub fn dav( id: &str, address: &str, host: &str, url: Option<&str>, username: Option<&str>, ) -> Account

A contacts-and-calendars account: host names its keyring entry, url is where its server was found.

pub fn is_dav(&self) -> bool

Whether Sioul syncs this account’s contacts and calendars.

Trait Implementations

impl Clone for Account

fn clone(&self) -> Account

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Account

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Account

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.