Repository files navigation

The chatmail core library implements low-level network and encryption protocols,integrated by many chat bots and higher level applications,allowing to securely participate in the globally scaled e-mail server network.We provide reproducibly-builtdeltachat-rpc-server static binariesthat offer a stdio-based high-level JSON-RPC API for instant messaging purposes.

The following protocols are handled without requiring API users to know much about them:

• secure TLS setup with DNS caching and shadowsocks/proxy support

• robustSMTPandIMAP handling

• safe and interoperableMIME parsingandMIME building.

• security-audited end-to-end encryption withrPGPandAutocrypt and SecureJoin protocols

• ephemeralPeer-to-Peer networking using Iroh for multi-device setup andwebxdc realtime data.

• a simulation- and real-world testedP2P group membershipprotocol without requiring server state.

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 the command line utility, usingcargo:

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

where ~/profile-db is the database file. The utility will create it if it does not exist.

Optionally, installdeltachat-repl binary with

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

and run as

$ deltachat-repl ~/profile-db

Configure your account (if not already configured):

Chatmail 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.

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

Run fuzzing tests with

$cd fuzz$ cargo bolerotest fuzz_mailparse -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.

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

To add the updates from theprovider-db to the core,check lineREV= inside./scripts/update-provider-database.shand then run the script.

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