Deprecated Deltachat Core Library
This library is deprecated and outdated!
Please see https://github.com/deltachat/deltachat-core-rust for the current library, which also contains a largely compatible C API as well as Python bindings.
Old readme below:
Delta Chat Core Library
The Delta Chat Core Library is written in cross-platform C, documented at https://c.delta.chat.
In the ci_scripts directory you'll find docker- and library-building scripts.
binary/distribution packages (work-in-progress)
There are work-in-progress efforts for creating (binary) packages which do not require that you build the library manually:
If you can help with advancing or adding to these efforts, please do contribute.
Otherwise read on for how to get
installed into your system.
building your own
getting a recent enough
meson for building
If you have installed
meson in your environment check the version::
You need to have version
0.47.2 at least. If the version
is older there is a recommended way of getting a better version:
uninstall your system-level
mesonpackage (if possible)
ensure you have at least
python3.5installed and type:
python3 -m pip
to check that you have "pip" installed. If not available, you might get it as a
python3-pippackage or you could follow installing pip.
then pip-install meson into your home-directory:
python3 -u -m pip install meson
-ucauses the pip-install to put a
mesoncommand line tool into
~/.local/or %APPDATA%\Python on Windows.
meson --versionto verify it's at at least version 0.48.0 now. If the
mesoncommand is not found, add
PATHand try again (
export PATH=~/.local/bin:$PATHon many unix-y terminals).
On Linux and Mac you need to install 'ninja-build' (debian package name) to be able to actually build/compile things.
Note that most dependencies below are detected using pkg-config. Usually this just works automatically, provided the depending libraries are installed correctly.
installing c-level dependencies
The deltachat core library depends on a number of external libraries, which you may need to install (we have some fallbacks if you don't):
LibEtPan; Note that this library does not use pkg-config so the system-provided version will be looked up by using
libetpan-configwhich must be in the PATH. Version 1.8 or newer is required. LibEtPan must be compiled with SASL support enabled.
To install these on debian you can type:
sudo apt install libetpan-dev libssl-dev libsqlite3-dev libsasl2-dev libbz2-dev zlib1g-dev
If you run into connection problems with IMAP (error #43) it might be the case that the
libetpan version on your system is too old. In this case we recommend compiling
libetpan with a minimum version of 1.9.1. See dinhviethoa/libetpan#330 for more details on why.
git clone https://github.com/dinhviethoa/libetpan.git cd libetpan ./autogen.sh ./configure --disable-silent-rules \ --enable-ipv6 \ --enable-iconv \ --disable-db \ --with-openssl \ --with-sasl \ --with-zlib \ --without-curl \ --without-expat make -j $(nproc) sudo make install sudo ldconfig -v
performing the actual build
Once all dependencies are installed, creating a build is as follows, starting from a deltachat-core github checkout:
mkdir builddir cd builddir meson # Optionally configure some other parameters # run `meson configure` to see the options, e.g. # meson configure --default-library=static ninja sudo ninja install # if you run into problems, the sudo-flag -E might help 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
/etc/ld.so.conf.d/*, which is fairly
standard. It is possible your system uses
/usr/local/lib/x86_64-linux-gnu which should be auto-detected and
just work as well.
The library is build using netpgp by default (shipped in /libs).
-Drpgp=true to the build command, rpgp is used instead
needs to be installed on the system or available as a lib)
Building without system-level dependencies
By default stripped-down versions of the dependencies are bundled with
Delta Chat Core and these will be used when a dependency is missing.
You can choose to always use the bundled version of the dependencies
by invoking meson with the
Likewise you can forbid using the bundled dependencies using
There also is an experimental feature where you can build a version of the
libdeltachat.so library with no further external
dependencies. This can be done by passing the
option to meson. Note that this implies
since this will always use all the bundled dependencies.
Language bindings and frontend Projects
Language bindings are available for:
The following "frontend" project make use of the C-library or its language bindings:
After a successful build there is also a little testing program in
You start the program with
(if the database file does not exist, it is created).
The program then shows a prompt and typing
help gives some help about the available commands.
New tests are currently developed using Python, see https://github.com/deltachat/deltachat-core/tree/master/python/tests
Licensed under the MPL 2.0 see LICENSE file for details.
Copyright © 2017, 2018 Björn Petersen and Delta Chat contributors.