Skip to content


Repository files navigation

QXmpp - Cross-platform C++/Qt XMPP library

QXmpp logo

XMPP:2022 Client IM Mobile+ Compliance Badge

Build Status Code Coverage Latest release Documentation Development Chat Donate using Liberapay REUSE status

QXmpp is a cross-platform C++ XMPP client and server library. It is written in C++ and uses the Qt framework.

QXmpp strives to be as easy to use as possible. The underlying TCP socket, the core XMPP RFCs (RFC6120 and RFC6121) and the supported XMPP extensions have been nicely encapsulated in classes. With QXmpp, it is possible to build XMPP clients complying with the XMPP Compliance Suites 2022 for IM and Advanced Mobile. It comes with full API documentation, automatic tests and examples.

QXmpp uses Qt extensively. Thus, users need to have a good knowledge of C++ and Qt basics (including the concept of signals/slots and Qt's data types). Qt is the only third party library required to build QXmpp, but libraries such as GStreamer enable additional features.

QXmpp is released under the terms of the GNU Lesser General Public License, version 2.1 or later.


QXmpp requires Qt 5.15 or Qt 6.0 or higher with SSL enabled.

You can build QXmpp with CMake:

mkdir build
cd build
cmake ..
cmake --build .

You can pass the following arguments to CMake:

Option Default Description
BUILD_SHARED ON Build as shared library, otherwise static
BUILD_DOCUMENTATION ON Build documentation, requires Doxygen
BUILD_EXAMPLES ON Build examples
BUILD_TESTS ON Build unit tests
BUILD_INTERNAL_TESTS OFF Build unit tests testing private parts of the API
BUILD_OMEMO OFF Build the OMEMO module
WITH_GSTREAMER OFF Enable audio/video over Jingle
QT_VERSION_MAJOR=5/6 to build with a specific Qt major version, prefers Qt 6 if undefined

For example, to build without unit tests you could do:



After building QXmpp, you can install it using the following command:

cmake --build . --target install


There are various examples in order to quickly start using QXmpp.


This example connects to the XMPP server and starts receiving presences from the server. You can see whether the user is online and if the user is in your roster (contact list).


This is a very simple bot which echoes the message sent to it. The example helps to understand how to receive and send messages.


There is an API documentation for the latest stable QXmpp version and one for the master branch.

Supported Platforms

QXmpp should work on all platforms supported by Qt.


If you think you have found a bug in QXmpp, we would like to hear about it. That way, we can fix it. Before reporting a bug, please check if the issue is already known at.


If you are interested in contributing to QXmpp, please have a look at our contribution guidelines.