monperrus / deltachat-core-rust

Delta Chat Rust Core library, used by Android/iOS/desktop apps and bindings

Delta Chat Rust

Deltachat-core written in Rust

Installing Rust and Cargo

To download and install the official compiler for the Rust programming language, and the Cargo package manager, run the command in your user environment:

curl https://sh.rustup.rs -sSf | sh

Using the CLI client

Compile and run Delta Chat Core command line utility, using cargo:

cargo run --example repl -- /path/to/db

Configure your account (if not already configured):

Delta Chat Core is awaiting your commands.
> set addr [e-mail]
> set mail_pw yourpassword
> configure

Connect to your mail server (if already configured):

> connect

Create a contact:

> addcontact [e-mail]
Command executed successfully.

List contacts:

> listcontacts
Contact#10: <name unset> <[e-mail]>
Contact#1: Me √√ <[e-mail]>

Create a chat with your friend and send a message:

> createchat 10
Single#10 created successfully.
> chat 10
Single#10: [e-mail] [[e-mail]]
> send hi
Message sent.

If [e-mail] uses DeltaChat, but does not receive message just sent, it is advisable to check Spam folder. It is known that at least gmx.com treat such test messages as spam, unless told otherwise with web interface.

List messages when inside a chat:

> chat

For more commands type:

> help

Development

# run tests
$ cargo test --all
# build c-ffi
$ cargo build -p deltachat_ffi --release

Debugging environment variables

• DCC_IMAP_DEBUG: if set IMAP protocol commands and responses will be printed

• DCC_MIME_DEBUG: if set outgoing and incoming message will be printed

Expensive tests

Some tests are expensive and marked with #[ignore], to run these use the --ignored argument to the test binary (not to cargo itself):

$ cargo test -- --ignored

Features

• vendored: When using Openssl for TLS, this bundles a vendored version.
• nightly: Enable nightly only performance and security related features.

Language bindings and frontend projects

Language bindings are available for:

• C
• Node.js
• Python
• Go
• Java and Swift (contained in the Android/iOS repos)

The following "frontend" projects make use of the Rust-library or its language bindings:

• Android
• iOS
• Desktop
• Pidgin
• several Bots