mirror of
https://github.com/chatmail/core.git
synced 2026-04-17 21:46:35 +03:00
dfd58961f7
The function is made safe and now returns Result. Functionally it now fails when it can not write the newly generated key to the database whereas before it still returned the key but logged a warning. There is no reason this shouldn't be able to store the key and silently not storing the key may result in later operations assuming the key is available, so failing seems like a better choice. The function now also uses a proper mutex to guard against multiple threads generating keys. And this mutex is Context-scoped rather than fully global (static).
110 lines
2.5 KiB
Markdown
110 lines
2.5 KiB
Markdown
# Delta Chat Rust
|
|
|
|
> Project porting deltachat-core to rust
|
|
|
|
[![CircleCI build status][circle-shield]][circle] [![Appveyor build status][appveyor-shield]][appveyor]
|
|
|
|
Current commit on deltachat/deltachat-core: `12ef73c8e76185f9b78e844ea673025f56a959ab`.
|
|
|
|
## 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 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 your@email.org
|
|
> set mail_pw yourpassword
|
|
> configure
|
|
```
|
|
|
|
Connect to your mail server (if already configured):
|
|
|
|
```
|
|
> connect
|
|
```
|
|
|
|
Create a contact:
|
|
|
|
```
|
|
> addcontact yourfriends@email.org
|
|
Command executed successfully.
|
|
```
|
|
|
|
List contacts:
|
|
|
|
```
|
|
> listcontacts
|
|
Contact#10: <name unset> <yourfriends@email.org>
|
|
Contact#1: Me √√ <your@email.org>
|
|
```
|
|
|
|
Create a chat with your friend and send a message:
|
|
|
|
```
|
|
> createchat 10
|
|
Single#10 created successfully.
|
|
> chat 10
|
|
Single#10: yourfriends@email.org [yourfriends@email.org]
|
|
> send hi
|
|
Message sent.
|
|
```
|
|
|
|
If `yourfriend@email.org` 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
|
|
|
|
```sh
|
|
# run tests
|
|
$ cargo test --all
|
|
# build c-ffi
|
|
$ cargo build -p deltachat_ffi --release
|
|
```
|
|
|
|
### 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):
|
|
```sh
|
|
$ cargo test -- --ignored
|
|
```
|
|
|
|
## Features
|
|
|
|
- `vendored`: When using Openssl for TLS, this bundles a vendored version.
|
|
- `nightly`: Enable nightly only performance and security related features.
|
|
- `ringbuf`: Enable the use of [`slice_deque`](https://github.com/gnzlbg/slice_deque) in pgp.
|
|
|
|
[circle-shield]: https://img.shields.io/circleci/project/github/deltachat/deltachat-core-rust/master.svg?style=flat-square
|
|
[circle]: https://circleci.com/gh/deltachat/deltachat-core-rust/
|
|
[appveyor-shield]: https://ci.appveyor.com/api/projects/status/lqpegel3ld4ipxj8/branch/master?style=flat-square
|
|
[appveyor]: https://ci.appveyor.com/project/dignifiedquire/deltachat-core-rust/branch/master
|