~soywod/himalaya-lib

#📫 Himalaya

Rust library for email management.

let account_config = AccountConfig {
    email: "test@localhost".into(),
    display_name: Some("Test".into()),
    email_sender: EmailSender::Internal(SmtpConfig {
        host: "localhost".into(),
        port: 587,
        starttls: Some(true),
        login: "login".into(),
        passwd_cmd: "echo password".into(),
        ..Default::default()
    }),
    ..Default::default()
};

let imap_config = ImapConfig {
    host: "localhost".into(),
    port: 993,
    starttls: Some(true),
    login: "login".into(),
    passwd_cmd: "echo password".into(),
    ..Default::default()
};
let backend_config = BackendConfig::Imap(&imap_config);

let mut backend = BackendBuilder::build(&account_config, &backend_config).unwrap();
backend.envelope_list("INBOX", 10, 0).unwrap();
backend.email_move("INBOX", "Archives", "21").unwrap();
backend.email_delete("INBOX", "42").unwrap();

let mut sender = SenderBuilder::build(&account_config).unwrap();
let email = Email::from_tpl("To: test2@localhost\r\nSubject: Hello\r\n\r\nContent").unwrap();
sender.send(&account_config, &email).unwrap();

The project is under active development. Do not use in production before the v1.0.0.

#Introduction

The role of this library is to extract and expose an API for managing emails. This way, you can build clients that match the best your workflow without reiventing the wheel. Here the list of available clients built by the community:

• CLI
• Vim plugin
• Emacs plugin (beta)
• GUI (comming soon)
• Web server

#Features

• IMAP, Maildir and Notmuch backends
• SMTP and Sendmail senders
• List, add and delete folders (mailboxes)
• List and search envelopes
• Get, add, copy, move and delete emails
• Add, set and delete flags
• Multi-accounting
• Folder aliases
• PGP end-to-end encryption
• IMAP IDLE mode for real-time notifications

#Development

The development environment is managed by Nix. Running nix-shell will spawn a shell with everything you need to get started with the lib: cargo, cargo-watch, rust-bin, rust-analyzer, notmuch…

# starts a nix shell
$ nix-shell

# then builds the lib
$ cargo build

#Testing

Before running the test suite you need to spawn an IMAP server. Here an example with docker and greenmail:

$ docker run -it --rm \
  -p 3025:3025 -p 3110:3110 -p 3143:3143 -p 3465:3465 -p 3993:3993 -p 3995:3995 \
  -e GREENMAIL_OPTS='-Dgreenmail.setup.test.all -Dgreenmail.hostname=0.0.0.0 -Dgreenmail.auth.disabled -Dgreenmail.verbose' \
  greenmail/standalone:1.6.2
  
$ cargo test

#Contributing

If you find a bug, feel free to open an issue at ~soywod/himalaya-lib.

If you have a feature in mind, feel free to send a patchset at https://git.sr.ht/~soywod/himalaya-lib/send-email or using the command git send-email.

#Sponsoring