Repository files navigation

The core library for Delta Chat, written in Rust

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

On Windows, you may need to also installPerl to be able to compile deltachat-core.

Compile and run Delta Chat Core command line utility, usingcargo:

$ cargo run --locked -p deltachat-repl -- ~/deltachat-db

where ~/deltachat-db is the database file. Delta Chat will create it if it does not exist.

Optionally, installdeltachat-repl binary with

$ cargo install --locked --path deltachat-repl/

and run as

$ deltachat-repl ~/deltachat-db

Configure your account (if not already configured):

Delta Chat Core is awaiting your commands.> set addr your@email.org> set mail_pw yourpassword> configure

Connect to your mail server (if already configured):

> connect

Create a contact:

> addcontact yourfriends@email.orgCommand executed successfully.

List contacts:

> listcontactsContact#10: <name unset> <yourfriends@email.org>Contact#1: Me √√ <your@email.org>

Create a chat with your friend and send a message:

> createchat 10Single#10 created successfully.> chat 10Single#10: yourfriends@email.org [yourfriends@email.org]> send hiMessage sent.

Ifyourfriend@email.org uses DeltaChat, but does not receive message justsent, it is advisable to checkSpam folder. It is known that at leastgmx.com treat such test messages as spam, unless told otherwise with webinterface.

List messages when inside a chat:

> chat

For more commands type:

> help

$ git clone https://github.com/chatmail/core.git$ cd deltachat-core-rust$ cmake -B build . -DCMAKE_INSTALL_PREFIX=/usr$ cmake --build build$ sudo cmake --install build

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

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

• RUST_LOG=async_imap=trace,async_smtp=trace: enable IMAP andSMTP tracing in addition to info messages.

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

$ cargotest -- --ignored

Installcargo-bolero with

$ cargo install cargo-bolero@0.8.0

Run fuzzing tests with

$cd fuzz$ cargo bolerotest fuzz_mailparse --release=false -s NONE

Corpus is created atfuzz/fuzz_targets/corpus,you can add initial inputs there.Forfuzz_mailparse target corpus can be populated with../test-data/message/*.eml.

To run with AFL instead of libFuzzer:

$ cargo bolerotest fuzz_format_flowed --release=false -e afl -s NONE

• vendored: When using Openssl for TLS, this bundles a vendored version.

To add the updates from theprovider-db to the core, run:

./src/provider/update.py ../provider-db/_providers/ > src/provider/data.rs

Language bindings are available for:

• C [📂 source |📚 docs]
• JS: [📂 source |📦 npm |📚 docs]
• Python [📂 source |📦 pypi |📚 docs]
• Go
  • over jsonrpc: [📂 source]
  • over cffi¹: [📂 source]
• Free Pascal¹ [📂 source]
• Java andSwift (contained in the Android/iOS repos)

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

• Android
• iOS
• Desktop
• Pidgin
• Telepathy
• Ubuntu Touch
• severalBots