1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

//! Rust library to manage your emails.
//!
//! The core concept of this library is to implement email actions and
//! to expose them into backend-agnostic abstractions. This way, you
//! can easily build email interfaces without caring about how to
//! connect to an IMAP server or how to send an email via SMTP.
//!
//! Here some key structures to better understand the concept of the
//! library:
//!
//!  - [`AccountConfig`](account::AccountConfig)
//!  - [`Folder`](folder::Folder)
//!  - [`Envelope`](email::Envelope)
//!  - [`Message`](email::Message)
//!  - [`Flag`](email::Flag)
//!  - [`Backend`](backend::Backend)
//!  - [`Sender`](sender::Sender)
//!
//! ## Backend and sender
//!
//! `pimalaya-email` provides two main abstractions---a backend and
//! a sender---as represented by their respective traits ([`Backend`]
//! and [`Sender`].)
//!
//! - A **backend** provides the ability to interact with an email
//!   server (e.g. IMAP or Maildir), by providing read/write operations
//!   on folders and messages.
//! - A **sender** provides the ability to send emails. This is
//!   analogous to the functionality of e.g. the SMTP protocol.
//!
//! `pimalaya-email` provides some default implementations of these
//! traits, found in their respective modules.

pub mod account;
pub mod backend;
pub mod email;
pub mod folder;
pub mod sender;

#[doc(inline)]
pub use backend::Backend;
#[doc(inline)]
pub use sender::Sender;

/// The global `Error` enum of the library.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    #[error(transparent)]
    AccountConfigError(#[from] account::config::Error),
    #[error(transparent)]
    OAuth2ConfigError(#[from] account::config::oauth2::Error),
    #[error(transparent)]
    PasswdConfigError(#[from] account::config::passwd::Error),
    #[error(transparent)]
    AccountSyncError(#[from] account::sync::Error),
    #[cfg(feature = "pgp-native")]
    #[error(transparent)]
    NativePgpConfigError(#[from] account::config::pgp::native::Error),

    #[error(transparent)]
    MessageError(#[from] email::message::Error),
    #[error(transparent)]
    TplError(#[from] email::message::template::Error),
    #[cfg(feature = "imap-backend")]
    #[error(transparent)]
    ImapEnvelopeError(#[from] email::envelope::imap::Error),
    #[error(transparent)]
    FlagError(#[from] email::envelope::flag::Error),
    #[cfg(feature = "imap-backend")]
    #[error(transparent)]
    ImapFlagError(#[from] email::envelope::flag::imap::Error),
    #[error(transparent)]
    MaildirFlagError(#[from] email::envelope::flag::maildir::Error),
    #[error(transparent)]
    EmailSyncError(#[from] email::sync::Error),

    #[error(transparent)]
    BackendError(#[from] backend::Error),
    #[cfg(feature = "imap-backend")]
    #[error(transparent)]
    ImapError(#[from] backend::imap::Error),
    #[cfg(feature = "imap-backend")]
    #[error(transparent)]
    ImapConfigError(#[from] backend::imap::config::Error),
    #[error(transparent)]
    MaildirError(#[from] backend::maildir::Error),
    #[cfg(feature = "notmuch-backend")]
    #[error(transparent)]
    NotmuchError(#[from] backend::notmuch::Error),

    #[error(transparent)]
    SenderError(#[from] sender::Error),
    #[error(transparent)]
    SendmailError(#[from] sender::sendmail::Error),
    #[cfg(feature = "smtp-sender")]
    #[error(transparent)]
    SmtpError(#[from] sender::smtp::Error),
    #[cfg(feature = "smtp-sender")]
    #[error(transparent)]
    SmtpConfigError(#[from] sender::smtp::config::Error),

    #[error(transparent)]
    SqliteError(#[from] rusqlite::Error),
}

/// The global `Result` alias of the library.
pub type Result<T> = std::result::Result<T, Error>;