Struct email::backend::ImapConfig

pub struct ImapConfig {
    pub host: String,
    pub port: u16,
    pub ssl: Option<bool>,
    pub starttls: Option<bool>,
    pub insecure: Option<bool>,
    pub login: String,
    pub auth: ImapAuthConfig,
    pub notify_cmd: Option<String>,
    pub notify_query: Option<String>,
    pub watch_cmds: Option<Vec<String>>,
}

The IMAP backend configuration.

Fields

host: String

The IMAP server host name.

port: u16

The IMAP server host port.

ssl: Option<bool>

Enables TLS/SSL.

Defaults to true.

starttls: Option<bool>

Enables StartTLS.

Defaults to false.

insecure: Option<bool>

Trusts any certificate.

Defaults to false.

login: String

The IMAP server login.

Usually, the login is either the email address or its left part (before @).

auth: ImapAuthConfig

The IMAP server authentication configuration.

Authentication can be done using password or OAuth 2.0. See ImapAuthConfig.

notify_cmd: Option<String>

The IMAP notify command.

Defines the command used to notify the user when a new email is available. Defaults to notify-send "📫 <sender>" "<subject>".

notify_query: Option<String>

The IMAP notify query.

Defines the IMAP query used to determine the new emails list. Defaults to NEW.

watch_cmds: Option<Vec<String>>

The watch commands.

Defines the commands to run whenever a change occurs on the IMAP server.

Implementations

impl ImapConfig

pub fn ssl(&self) -> bool

TLS/SSL option getter.

pub fn starttls(&self) -> bool

StartTLS option getter.

pub fn insecure(&self) -> bool

Insecure option getter.

pub fn notify_query(&self) -> String

Notify query option getter.

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

Watch commands option getter.

pub async fn run_notify_cmd( &self, id: u32, subject: impl AsRef<str>, sender: impl AsRef<str> ) -> Result<()>

Runs the IMAP notify command.

pub async fn build_credentials(&self) -> Result<String>

Builds authentication credentials.

Authentication credentials can be either a password or an OAuth 2.0 access token.

Trait Implementations

impl Clone for ImapConfig

fn clone(&self) -> ImapConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImapConfig

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

Formats the value using the given formatter.

impl Default for ImapConfig

fn default() -> ImapConfig

Returns the “default value” for a type.

impl PartialEq<ImapConfig> for ImapConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ImapConfig

impl StructuralEq for ImapConfig

impl StructuralPartialEq for ImapConfig