Struct ImapConfig

pub struct ImapConfig {
    pub host: String,
    pub port: u16,
    pub encryption: Option<Encryption>,
    pub login: String,
    pub auth: ImapAuthConfig,
    pub extensions: Option<ImapExtensionsConfig>,
    pub watch: Option<ImapWatchConfig>,
    pub clients_pool_size: Option<u8>,
}

Errors related to the IMAP backend configuration. The IMAP backend configuration.

Fields

host: String

The IMAP server host name.

port: u16

The IMAP server host port.

encryption: Option<Encryption>

The IMAP encryption protocol to use.

Supported encryption: SSL/TLS, STARTTLS or none.

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.

extensions: Option<ImapExtensionsConfig>

The IMAP extensions configuration.

watch: Option<ImapWatchConfig>

The IMAP notify command.

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

clients_pool_size: Option<u8>

The IMAP clients pool size.

Defines the number of clients that are created and managed simultaneously by the IMAP context. Defaults to 1.

Implementations

impl ImapConfig

pub fn clients_pool_size(&self) -> u8

pub fn send_id_after_auth(&self) -> bool

pub fn is_encryption_enabled(&self) -> bool

Return true if TLS or StartTLS is enabled.

pub fn is_start_tls_encryption_enabled(&self) -> bool

Return true if StartTLS is enabled.

pub fn is_encryption_disabled(&self) -> bool

Return true if encryption is disabled.

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.

pub fn find_watch_timeout(&self) -> Option<u64>

Find the IMAP watch timeout.

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<'de> Deserialize<'de> for ImapConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ImapConfig

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SyncHash for ImapConfig

fn sync_hash(&self, state: &mut DefaultHasher)

impl Eq for ImapConfig

impl StructuralPartialEq for ImapConfig