mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-05 19:42:04 +02:00

No description

Find a file

Floris Bruynooghe e8180dda9a Add very basic meson build infrastructure This manages to build the .so and test binary on Debian stretch.		2017-12-29 13:38:39 +01:00
cmdline	Add very basic meson build infrastructure	2017-12-29 13:38:39 +01:00
docs	doxygen	2017-12-19 16:08:36 +01:00
libs	Add very basic meson build infrastructure	2017-12-29 13:38:39 +01:00
src	Add very basic meson build infrastructure	2017-12-29 13:38:39 +01:00
.gitattributes	Force Unix-lineends.	2016-07-13 15:42:54 +02:00
.gitignore	Add compiled docs to repository.	2017-11-14 02:47:49 +01:00
deltachat-core.cbp	basically switch to the new hashed headers	2017-12-07 18:19:35 +01:00
LICENSE	Upgrade to GPL v3.	2016-10-01 09:55:41 +02:00
meson.build	Add very basic meson build infrastructure	2017-12-29 13:38:39 +01:00
README.md	be more clear in the readme, fix grammar	2017-12-27 14:56:42 -05:00

README.md

Delta Chat Core Library

You can use the Delta Chat Core Library to build your own messenger or plugin, that is completely compatible to the existing email infrastructure.

Using this library in your app, you get the ease of well-known messengers with the reach of e-mail. Moreover, you're independent from other companies or services as your data is not relayed through Delta Chat, only your email provider. That means that there are no Delta Chat servers, only clients that are compatible via Delta Chat Core.

The library is used eg. in the Delta Chat Android Frontend or in the Delta Chat iOS Frontend but can also be used for completely different messenger projects.

Some features at a glance

Secure with automatic end-to-end-encryption, supporting the new Autocrypt standard
Fast by the use of Push-IMAP
Read receipts
Largest userbase - receivers not using Delta Chat can be reached as well
Compatible - not only to itself
Elegant and simple user interface
Distributed system
No Spam - only messages of known users are shown by default
Reliable - safe for professional use
Trustworthy - can even be used for business messages
Libre software and standards-based

API Documentation

The C-API is documented at https://deltachat.github.io/deltachat-core/html/.

Please keep in mind, that your derived work must be released under a GPL-compatible licence. For details, please have a look at the LICENSE file accompanying the source code.

Build

The Delta Chat Core Library relies on the following external libs:

LibEtPan, OpenSSL; for compilation, use eg. the following commands: ./autogen.sh; make; sudo make install prefix=/usr To link against LibEtPan, add libetpan-config --libs in backticks to your project. This should also add the needed OpenSSL libraries.
SQLite is available on most systems, however, you will also need the headers, please look for packages as libsqlite3-dev. To link against SQLite, add -lsqlite3 to your project.

Alternatively, use the ready-to-use files from the libs-directory which are suitable for common system. You'll also find a fork of the needed Netpgp library there.