1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-03 17:59:19 +02:00
No description
Find a file
2018-01-20 23:58:28 +01:00
cmdline where to find the CLI - How to speed up the start 2018-01-20 23:58:28 +01:00
docs doxygen 2018-01-08 22:36:30 +01:00
libs Make libbz2 a proper dependency 2018-01-02 14:47:31 +01:00
python Add free definition 2018-01-06 22:30:46 +01:00
src typos fixed (logs & comments) 2018-01-20 22:51:42 +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 Update build instructions for meson 2017-12-29 18:59:05 +01:00
README.md added missing 'sudo' commands 2018-01-20 23:40:27 +01:00

Delta Chat Core Library

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

Logo

Using this library in your app, you get the ease of well-known messengers with the reach of email. 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 made compatible via Delta Chat Core.

The library is used eg. in the Delta Chat Android Frontend and 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 - recipients 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

Delta Chat Core can be built as a library using the meson build system. It depends on a number of external libraries, most of which are detected using pkg-config. Usually this just works automatically, provided the depending libraries are installed correctly.

Installing all of these using your system libraries is the easiest route. Please note that you may need "development" packages installed for these to work.

  • LibEtPan; this does not use pkg-config, instead it ships with a libetpan-config binary which must be in the PATH to be picked up by the build system.

  • OpenSSL

  • SQLite

  • zlib

  • libsasl

  • bzip2

To build you need to have meson and ninja installed as well.

On Linux (e.g. Debian Stretch) you can install all these using:

sudo apt install libetpan-dev libssl-dev libsqlite3-dev libsasl2-dev libbz2-dev zlib1g-dev meson ninja-build.

Once all dependencies are installed, creating a build is as follows, starting from the project's root directory:

mkdir builddir
cd builddir
meson
# optionally configure some parameters
# run `meson configure` to see the options, e.g. 
meson config -Dlibdir=lib
ninja
sudo ninja install
sudo ldconfig

The install keeps a log of which files were installed. Uninstalling is thus also supported:

sudo ninja uninstall

Note that the above assumes /usr/local/lib is configured somewhere in /etc/ld.so.conf or /etc/ld.so.conf.d/*, which is fairly standard.


Copyright © 2018 Delta Chat contributors