mirror of
https://github.com/chatmail/core.git
synced 2026-04-20 23:16:30 +03:00
140 lines
2.9 KiB
Markdown
140 lines
2.9 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`.
|
|
|
|
## Development
|
|
|
|
```sh
|
|
# run example
|
|
$ cargo run --example simple
|
|
# build header file
|
|
$ cargo build -p deltachat_ffi --release
|
|
$ cat deltachat-ffi/deltachat.h
|
|
# run tests
|
|
$ cargo test --all
|
|
```
|
|
|
|
[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
|
|
|
|
## Using the CLI client
|
|
|
|
Run 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
|
|
```
|
|
|
|
If you're already configured it's enough to `> 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.
|
|
```
|
|
|
|
For more commands type `> help`:
|
|
|
|
```
|
|
> help
|
|
==========================Database commands==
|
|
info
|
|
open <file to open or create>
|
|
close
|
|
set <configuration-key> [<value>]
|
|
get <configuration-key>
|
|
oauth2
|
|
configure
|
|
connect
|
|
disconnect
|
|
maybenetwork
|
|
housekeeping
|
|
help imex (Import/Export)
|
|
==============================Chat commands==
|
|
listchats [<query>]
|
|
listarchived
|
|
chat [<chat-id>|0]
|
|
createchat <contact-id>
|
|
createchatbymsg <msg-id>
|
|
creategroup <name>
|
|
createverified <name>
|
|
addmember <contact-id>
|
|
removemember <contact-id>
|
|
groupname <name>
|
|
groupimage [<file>]
|
|
chatinfo
|
|
sendlocations <seconds>
|
|
setlocation <lat> <lng>
|
|
dellocations
|
|
getlocations [<contact-id>]
|
|
send <text>
|
|
sendimage <file> [<text>]
|
|
sendfile <file>
|
|
draft [<text>]
|
|
listmedia
|
|
archive <chat-id>
|
|
unarchive <chat-id>
|
|
delchat <chat-id>
|
|
===========================Message commands==
|
|
listmsgs <query>
|
|
msginfo <msg-id>
|
|
listfresh
|
|
forward <msg-id> <chat-id>
|
|
markseen <msg-id>
|
|
star <msg-id>
|
|
unstar <msg-id>
|
|
delmsg <msg-id>
|
|
===========================Contact commands==
|
|
listcontacts [<query>]
|
|
listverified [<query>]
|
|
addcontact [<name>] <addr>
|
|
contactinfo <contact-id>
|
|
delcontact <contact-id>
|
|
cleanupcontacts
|
|
======================================Misc.==
|
|
getqr [<chat-id>]
|
|
getbadqr
|
|
checkqr <qr-content>
|
|
event <event-id to test>
|
|
fileinfo <file>
|
|
clear -- clear screen
|
|
exit
|
|
=============================================
|
|
```
|