Akonadi EWS resource now part of KDE PIM

From day one when I started working on the Akonadi resource for Microsoft Exchange I have dreamed for it to be part of KDE PIM itself one day. This week that dream has finally come true.

At this year’s Akademy meeting the EWS resource was recognized to be valuable and I was invited by Daniel Vratil to merge it to the KDE PIM codebase. After some integration and cleanups followed by a review and more cleanups the resource has finally become part of KDE. Many thanks to Daniel and Laurent Montel for all the great work they did in order for this to go smooth.

While doing the development I have made effort to adhere to KDE coding guidelines so that the shape of the resource – both from UI as well as actual source code corresponds to the rest of KDE so that if the transition would happen, the porting effort would be minimized. This has paid off reducing the time it took to import the code.

What’s next?

Being part of KDE PIM the EWS resource will be released together with all KDE PIM packages, which means that you’ll see it bundled with the 17.12 release which is due December this year.

Feature-wise the current state did not change much since the last 0.8.1 release – all the TODOs are still in place (full calendar, tasks, GAL). I plan to continue working on those features and on improved testing, even if progress may be a bit slow.

If you see some bugs (which I’m pretty sure there will be), please from now on report them to KDE Bugzilla using the newly created component (Akonadi/EWS Resource).

For anyone interested in helping me with some hacking, the code now lives in the kdepim-runtime repository under resources/ews. I will keep maintaining and evolving it as before. Being a part of KDE PIM it will now be developed and tested alongside all other KDE PIM components, which will make sure it does not suddenly break when some core changes are introduced.


Akonadi EWS Resource – first bugfix release

In the initial release announcement I have promised to focus on calendar support. Unfortunately I haven’t had that much time for development as I initially anticipated. In the meantime some early adopters have uncovered a number of issues that have since been fixed. In order to deliver those fixes I have decided to issue a bugfix release (0.8.1).

This release doesn’t bring any significant new features to the Akonadi EWS Resource. The most important changes include:

  • Improved collection tree retrieval:
    • Fixed full collection tree synchronisation for some servers (bug #2).
    • Fixed incremental collection tree synchronisation.
    • Reduced the number of full collection tree retrievals by keeping the state persistent.
  • Fixed Qt 5.7 compatibility
  • Fixed crash upon encountering a distribution list item (bug #7).
  • Improved behaviour in case of temporary server connection loss.
  • Added option to customise User Agent string sent to the server.
  • Added option to enable NTLMv2 authentication.
  • Allow specifying an empty domain name (bug #3). Requires KF 5.28 to have any effect.
  • Fixed dates when copying items from other resources to the Sent Items folder (bug #5).
  • Improved batch item retrieval performance (will be effective with KDE Applications 16.12).
  • Add synchronisation of collection tree upon connection. Fixes empty collection tree after adding a new resource until a manual mail fetch is triggered (bug #15).

As promised before I intend to focus on calendar support and hope to get it running in the next release.

Akonadi Resource for Microsoft Exchange Web Services (EWS)

Whether you are a Microsoft hater or a lover, when you have ever had a chance to work for a medium or large corporation, you have probably stumbled upon Microsoft Exchange mail server. While it can be made to talk to regular e-mail clients using standards such as IMAP, POP3 and SMTP, some corporate admins choose not to enable any of the standard mail protocols leaving the user with no choice other than to use Microsoft Outlook. Even if it is possible to use regular e-mail clients they will not be able to explore the full potential of Exchange, as it is not only a mail server but rather a groupware server which includes support for calendar, tasks, contacts and many more.

Why not talk to Exchange in its own language?

Exchange actually knows three of them:

  • MAPI
  • ActiveSync
  • Exchange Web Services (EWS)

MAPI was the primary way to communicate with Exchange until version 2007. It is now considered legacy and it’s for a good reason – it’s a complex protocol, not an easy one to work with. ActiveSync is focused towards mobile applications.

Exchange Web Services were introduced with Exchange 2007 and since then have become the new primary standard to communicate with Exchange.

There are not many e-mail clients that are able to use native Exchange protocols. Evolution is able to work with both MAPI and EWS, but the support is buggy. An extension exists for Thunderbird (ExQuilla), but it requires a license and also has some bugs.

The situation on the Akonadi front

Akonadi has so far seen support for two of the Exchange native protocols. A resource exists for MAPI (akonadi-exchange). It started off as a read-only resource to access the Global Address List and the calendar and has since evolved to allow retrieval of e-mail. Unfortunately because of MAPI complexness it is buggy and pulls it some Samba4 dependencies.

Another resource exists for ActiveSync. Unfortunately access to Exchange using this standard is often heavily restricted or even completely blocked by corporate admins due to security concerns.

Exchange Web Services

When I first started exploring Exchange Web Services I noticed that it is relatively easy to use and quite well documented by Microsoft itself (big thanks to the EU forcing MS to documents its standards). Given the lack of fully-featured Exchange support I have given it a try to develop an Akonadi resource that would use EWS in order to allow KDE PIM to access the full potential of Exchange.

After nearly six months of development the day has come to publish the initial release of this resource.

Current status

The initial version (0.8.0) focuses on e-mail support. It is possible to both send and receive e-mail without use of IMAP, POP3 or SMTP (yes, by default Outlook doesn’t send e-mail through SMTP, but uses the native protocol to do it). Full control over mailbox folder is also possible. You can copy, delete e-mail and manage all folders.

Once notable feature is server-side tag support. Thanks to Exchange support for custom properties it is possible to save Akonadi tags into Exchange so that they can be retrieved on another machine or after a system reinstall.

Support for other items is partial. Calendar is read-only – events are retrieved, reminders work, but there is no possibility to add, modify or delete events as well as invite attendees or respond to invitations from others.

Personal address book is also read-only. There is no support for the Global Address List and tasks.

Development of all the missing features will require more time and will be subject to subsequent releases. It is however worth to note that a number of changes will have to be introduced to Akonadi as in some cases it is based on assumptions, which are not true for Exchange.

Can I try it out?

Of course, you’re welcome to do so. The project is hosted on GitHub, where you can retrieve the latest bleeding edge state of development or – in case you prefer a stable solution – one of available releases (currently there is only one).

I have prepared packages for Fedora 23 and Ubuntu 16.04, but since I’m not a packaging expert please bare with me in case there are some issues.

Being a Gentoo user I have obviously prepared an overlay.

Note: While I have done my best to develop good quality software I am only a human and humans make mistakes. In this case mistakes could even cause your e-mail to be lost, so please use with caution.

Next steps

Once e-mail support is stable I intend to focus on calendar support, which should make the resource much more useful.

Apart from the resource itself I also intend to work on the KDE PIM packages itself in order to better integrate with the EWS resource. I already had to introduce some workarounds that I would like to get rid of.

In the long term I hope to make this resource part of KDE PIM so that people can use Exchange with it without the need to install any third-party software and rely on my poor packaging 😉