Twake Mail is a free, open source email & communication project written in Dart and released under AGPL-3.0. It has 653 GitHub stars, 127 forks and 388 open issues, and was last pushed 13 hours ago. On this registry it ranks #12 of 13 tracked projects in Email & Communication, with 5 head-to-head comparisons available.

What is Twake Mail?

Twake Mail is a multi-platform, open source email client written in Dart with Flutter that reads and manages mail over the JMAP protocol, built for people and organisations that want a modern client on Android, iOS, tablets, and the web without depending on a proprietary mail API.

What it is

Twake Mail is an open source email application developed by Linagora. It is written in Dart using the Flutter framework and is published for Android, iOS, and the web, where the web build ships as the Docker image linagora/tmail-web. The project describes itself as a multi-platform mobile email application that runs the JMAP protocol, and it also plans to deliver additional features to the Twake Mail back-end. It appears in this registry under Productivity & Utilities / Email & Communication, carries the AGPL-3.0 licence, and is tagged with email, flutter, hacktoberfest, jmap, and mobile.

The concrete problem it solves is IMAP. The project's own FAQ argues that IMAP, though ubiquitous, was designed in another age and became a chatty patchwork of extensions that lacks decent synchronization primitives for real-time mobile use, consumes bandwidth, and requires many round trips, which means high latency. Large providers answered those flaws with proprietary protocols such as the Gmail API and Exchange ActiveSync rather than an interoperable standard. Twake Mail replaces that fragmentation with JMAP, which builds on HTTP and JSON. Crucially, it works with any JMAP server, not only the Linagora back-end.

Key capabilities

  • Speaks JMAP over HTTP and JSON instead of IMAP and its extension patchwork.
  • Connects to any JMAP server, so it is not tied to the Linagora back-end.
  • Ships Android and iOS builds produced with flutter build apk and flutter build ios.
  • Provides a web client built with flutter build web and configured through SERVER_URL in env.file.
  • Publishes the web client as the Docker image linagora/tmail-web.
  • Handles tablet layouts and large rendering spaces, addressed early in development.
  • Adds features to the companion Twake Mail back-end project.

Who uses it and how

  • Mobile users install the Android app from Google Play or the iOS app from the App Store, both listed under the Linagora developer account.
  • Tablet users get a layout designed for larger rendering space rather than a stretched phone view.
  • Organisations running their own JMAP server deploy the web client themselves, pointing SERVER_URL at that server, or run the linagora/tmail-web image.
  • Contributors work through the issue tracker, the docs folder, and the project's Gitter channel; the hacktoberfest topic signals that outside contributions are welcome.

Getting started

From the project root, run /bin/bash scripts/prebuild.sh, then build with flutter build apk, flutter build ios, or flutter build web. For the web client, set SERVER_URL in env.file to your JMAP server first, or pull the prebuilt linagora/tmail-web image from Docker Hub.

How it compares

The facts name the Gmail API and Exchange ActiveSync as proprietary protocols that major providers built to work around IMAP's limitations, while Twake Mail implements JMAP, an interoperable open standard released under the AGPL-3.0. It pairs naturally with Linagora's own Twake Mail back-end, yet the README states plainly that any JMAP server will do.

When to use it — and when not to

Pick Twake Mail only if a JMAP server is available, because a provider offering IMAP or POP alone will not connect. Web self-hosters must either build with the Flutter toolchain or operate the linagora/tmail-web container, and a desktop application is planned rather than delivered. The README notes that user documentation is still planned, the repository carries 388 open issues, and the build steps assume some Flutter familiarity, so anyone wanting a fully documented, finished product should weigh that before adopting it.

project readme (upstream, from github) — read inline

Twake Mail Client

Contributors Issues Documentation Android application Ios application Web Mail Gitter

Logo

WebsiteReport Bug


This project aims at providing a multi-platform mobile email application, running the JMAP protocol and will also deliver additional features to the Twake Mail back-end.

Twake Mail is developed with love by Linagora.

Here is how Twake Mail looks like on a phone:

Screenshots Mobile

Here is how Twake Mail looks like on a tablet:

Screenshot Tablet

Screenshot_Web

Build app

  1. Go to root folder of project
  2. Run scripts/prebuild.sh script
/bin/bash scripts/prebuild.sh
  1. Build
  • iOS:
flutter build ios 
  • Android:
flutter build apk
  • Web:

change SERVER_URL in env.file with your JMAP server

SERVER_URL=http://your-jmap-server.domain

then run:

flutter build web

or you can find our images in: https://hub.docker.com/r/linagora/tmail-web

FAQ

Why did you choose JMAP?

Read more... That is a good question! **IMAP** is THE ubiquitous protocol people use to read their emails, THE norm.

Yet IMAP had been designed in another age, which resulted in a chatty patchwork of extensions. IMAP lacks decent synchronization primitives to address real-time challenges modern mobile fleet requires, it consumes a lot of bandwidth, requires a lot of round trips which means high latency.

We are not alone to say this! Big players of the field started their own proprietary protocols to address IMAP flaws, and inter-operable standard was yet to be found...

This, is where JMAP comes to play! JMAP builds on decades of experience, and beautifully addresses these challenges using HTTP and JSON standards. Not only does it make applications easier to develop, we also strongly believes it results in an improved experience for the end user.

Can I use Twake Mail with any JMAP server?

Yes, you can use the Twake Mail application with any JMAP server and benefits from Twake Mail's ease of use.

I don't understand your app... I need help using it! HELP MEEEEEE...

Read more... Don't worry, we are here!

We plan on writing a user documentation, helping you navigating around the application, and detailing the few configurations you have to perform.

If what you are looking for is not in the user guide then ask us directly in the issues first, we would be glad to help. But also glad to improve our documentation and maybe tweak slightly our UI (user interface).

What platforms do you (plan to) target?

Read more... First, we target Android, iOS mobiles. We also take care of tablets and large rendering space early on in the development process.

Then, we plan on introducing a desktop application.

This versatility is enabled by the use of the Flutter framework.

What would your roadmap look like?

Read more... Now that we plan having a simple JMAP email client supporting Android, IOS, and a webmail, we are working on some extra features on top of the TeamMail backend, including:
  • Better filters, with more actions, and combining conditions
  • Restoring deleted messages
  • Delegating full access to others for instance your security
  • Labels for better sorting your emails across folders
  • Automated actions: archiving, emptying your trash, your spam folders
  • Running filters against a folder
  • Attachment thumbnails

We are also planning active work on drag and drops and other user experience / productivity enhancements.

We do not currently plan working on desktop applications, on websockets for push on top of TeamMail web but such contributions would be appreciated. We also welcome feedback and pull requests regarding Team-Mail portability (running TeamMail on top of third party mail servers).

First, we plan to write a simple, multi-platform JMAP email client. This includes reading your mails and mailboxes, managing them, sending emails, searching your emails. This will likely keep us busy by the end of 2021.

Then, we have plan for multiple features including:

  • Support for Twake Mail encrypted mailbox (GPG)
  • Interactions with some other software from Linagora including:
    • Sending attachments via TDrive file sharing platform.
    • Transferring some attachments you received to TDrive file sharing platform.
    • Discussing some emails you received via Twake chat.

Any chance to support JMAP extension for calendar, contacts?

No we do not plan to support such extensions, that are currently not standardized as RFCs, nor implemented on the Twake Mail backend.

Do you have a web application for Twake Mail?

Read more... Yes! It is still in early development but we do have one. It's easy for you to use locally, as you can just build a Docker image locally from the sources of this repository, or even use our official Docker image `linagora/tmail-web`.

The web-app needs to include an environment file though (here you can see the dummy env.file at the root of the project), with a SERVER_URL parameter, so it knows to which backend it needs to connect to.

For this to run it locally for example, 2 ways:

Edit the environment file before the build

Edit the env.file by replacing the default value of SERVER_URL to the one pointing to your JMAP backend server. Then build your docker image:

docker build -t tmail-web:latest .

Then you can just simply run your web-app like this:

docker run -d -ti -p 8080:80 --name web tmail-web:latest

Then go to http://localhost:8080 and you should be able to login against your JMAP backend using the Twake Mail web-app.

Mount an environment file when running the container

You can use our official image linagora/tmail-web or just build the docker image locally without any prior changes:

docker build -t tmail-web:latest .

From then, create at the root of the project an environment file (like env.dev.file) where you put the SERVER_URL you want to connect to. Then, to mount it and override the default one while running the container:

docker run -d -ti -p 8080:80 --mount type=bind,source="$(pwd)"/env.dev.file,target=/usr/share/nginx/html/assets/env.file --name web tmail-web:latest

Then go to http://localhost:8080 and you should be able to login against your JMAP backend using the TMail web-app.

Using the docker-compose file

We also include a docker-compose.yaml file so you can get a testing environment up quickly. This use our tmail-backend image for the JMAP server.

Here are the steps to setup:

  1. Generate JWT keys for tmail-backend:
openssl genpkey -algorithm rsa -pkeyopt rsa_k

readme truncated — read the full docs on github

Frequently asked questions

Is Twake Mail free to use?

Twake Mail is open source under the AGPL-3.0 licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does Twake Mail do?

Secure open source email with advanced encryption & AI

What is Twake Mail written in?

Twake Mail is primarily written in Dart. Its source is publicly available at https://github.com/linagora/tmail-flutter, and it has 653 GitHub stars.