• Stars
    star
    314
  • Rank 133,353 (Top 3 %)
  • Language
    Dart
  • License
    GNU Affero Genera...
  • Created over 3 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A multi-platform (Flutter) application for reading your emails, with your favorite devices, using the JMAP protocol!

Team Mail Flutter mobile application

Gitter

LOGO

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

Here is how Team Mail looks like on a phone:

Screenshots Mobile

Here is how Team Mail looks like on a tablet:

Screenshot Tablet

Screenshot_Web

Build app

  1. Go to root folder of project
  2. Run prebuild.sh script
/bin/bash 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 synchronisation primitives to address real-time challenges modern mobile fleet requires, it consumes a lot of bandwith, requires a lot of roundtrips 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 Team Mail with any JMAP server?

Yes, you can use the Team Mail application with any JMAP server and benefits from Team Mail ergonomy and 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 plateforms 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... 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 Team Mail encrypted mailbox (GPG)
  • Support for Team Mail shared mailboxes
  • Support for Team Mail filters
  • Interactions with some other software from Linagora including:
    • Sending attachments via LinShare file sharing platform.
    • Transfering some attachments you received to LinShare 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 Team Mail backend.

Do you have a web application for Team 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 Team 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_keygen_bits:4096 -out jwt_privatekey
openssl rsa -in jwt_privatekey -pubout -out jwt_publickey
  1. Edit the env.file and set SERVER_URL to http://localhost/ (with the trailing slash)
  2. Run docker compose up -d to bring up both the frontend and the backend.
  3. Run docker compose exec tmail-backend /root/provisioning/provisioning.sh to provision some demo accounts (you don't have to let it run all the way).
  4. The TMail web-app should be available at http://localhost:8080. The credentials for demo accounts are:
User: alice@localhost
Password: aliceSecret

User: bob@localhost
Password: bobSecret

User: empty@localhost
Password: emptrySecret

More configurations for Team Mail web

- [Enable and customize the Application grid](docs/configuration/app_grid_configuration.md)
- [Change logos](docs/configuration/tmail-web-logo.md)

Your work is awesome! I would like to help you. What can I do?

Read more... Thanks for the enthousiasm!

There are many ways to help us, and amongst them:

  • Spread the word: Tell people you like Team Mail, on social medias, via blog posts etc...
  • Give us feedbacks... It's hard to make all good decisions from the first time. It is very likely we can benefit from your experience. Did you encountered annoying bugs? Do you think we can better arrange the layout? Do you think we are missing some features critical to you? Tell us in the issues.
  • I can code! I wanna help ;-). Wow thanks! Let's discuss your project together in the issues to get you on track!

Cool. I also want to write my own email application for JMAP. Can you help me?

You would be pleased to know we contributes a JMAP Dart client that you can reuse to write your own applications. Feels free to open pull requests and enrich it!

More Repositories

1

Twake

Twake is a secure open source collaboration platform to improve organizational productivity.
TypeScript
1,682
star
2

hublin

DEPRECATED - An easy and free video conference service based on WebRTC
JavaScript
1,585
star
3

openpaas-esn

Open PaaS Enterprise Social Network
JavaScript
464
star
4

linshare

LinShare
Shell
421
star
5

twake-drive

The open-source alternative to Google Drive.
TypeScript
67
star
6

docker-janus-gateway

Run janus gateway well configure for hublin in a Docker container.
65
star
7

jmap-client

This repository provides a javascript lib to make requests against a JMAP server.
JavaScript
65
star
8

twake-on-matrix

A multi-platform (Flutter) application for connecting to Matrix - an open network for secure, decentralized communication, with your favorite devices.
Dart
58
star
9

Twake-Mobile

Twake mobile application
Dart
57
star
10

linshare-core

Open Source secure files sharing
Java
53
star
11

linshare-docker

JavaScript
51
star
12

OBM

[ARCHIVED] OBM Opensource Groupware Solution
PHP
46
star
13

tmail-backend

Scala
40
star
14

james-jenkins

Immutable Jenkins CI for Apache James
Groovy
39
star
15

jmap-client-ts

JMAP 1.0 client library in TypeScript
TypeScript
36
star
16

jmap-dart-client

A JMAP client library in Dart to make JMAP method calls and process the responses
Dart
29
star
17

opush

[ARCHIVED]
Java
22
star
18

TED

Replicated, encrypted, scalable and realtime collections based database for Twake
TypeScript
17
star
19

linshare-mobile-android-app

Android application for LinShare - https://linshare.org/
Kotlin
17
star
20

awesome-angular-swipe

[ARCHIVED] This library uses $swipe then exposes a directive which allows mobile swipe feature on everything in the DOM.
JavaScript
17
star
21

linshare-ui-admin

Vue
16
star
22

linshare-mobile-flutter-app

Mobile application for LinShare - https://linshare.org/
Dart
16
star
23

angular-clockpicker

A wrapper for linagora/clockpicker
JavaScript
14
star
24

dynamic-directive

[ARCHIVED] AngularJS Dynamic Directives
JavaScript
11
star
25

esn-frontend-inbox

Webmail SPA for the OpenPaaS Suite - https://open-paas.org
JavaScript
11
star
26

flutter-date-range-picker

A Flutter package for all platform which provides a custom date picker
Dart
11
star
27

james-gatling

Gatling tests for James email server
Scala
10
star
28

ToM-server

TypeScript
10
star
29

openpaas-tip-of-the-day

[ARCHIVED] Contributing and coding in OpenPaas demystified through one tip per day.
SCSS
9
star
30

esn-frontend-calendar

Calendar SPA for the OpenPaaS Suite - https://open-paas.org/
JavaScript
8
star
31

james-parent

Shell
7
star
32

linagora.esn.chat

🐱 Module for OpenPaaS ESN
JavaScript
7
star
33

esn-sabre

SabreDAV for OpenPaaS ESN
PHP
7
star
34

mupee

[ARCHIVED] - A proxy to control the updates of your Mozilla software and addons
JavaScript
6
star
35

docker-sonarqube-pr

[ARCHIVED] Dockerized SonarQube for your Github and Stash PR
Shell
6
star
36

Twake-Desktop

Desktop App for Twake
TypeScript
6
star
37

esn-frontend-account

Account SPA for OpenPaaS https://open-paas.org/
JavaScript
6
star
38

poc-ejbca-ws-client.php

[ARCHIVED] a Proof of concept of an EJBCA webservice client written in PHP
PHP
6
star
39

james-admin-client

JS library to help configuring James through web administration APIs
JavaScript
6
star
40

linshare-database-dockerfile

Dockerfile
5
star
41

hubot-hublin

[ARCHIVED] Hubot integration with Hublin
CoffeeScript
5
star
42

esn-frontend-mailto

mailto: SPA for OpenPaaS
JavaScript
5
star
43

rich-text-composer

Unified rich text composer in Flutter
Dart
5
star
44

esn-frontend-contacts

Contacts SPA for the OpenPaaS Suite - https://open-paas.org/
JavaScript
5
star
45

linshare-ui-user

JavaScript
5
star
46

gatling-imap

IMAP Support for Gatling
Scala
5
star
47

hublin-ansible

[ARCHIVED] Automatic deployment tool for hubl.in
Shell
5
star
48

Landing

Landing site of Twake
HTML
5
star
49

OpenPaaS-NG-SP5

[ARCHIVED]
R
5
star
50

mozilla-version-comparator

[ARCHIVED] A node.js module that knows how to compare Mozilla products and addons versions
JavaScript
5
star
51

angular-translate-quality

[ARCHIVED] A JS library to verify the coherence and the correctness of angular-translate elements
JavaScript
4
star
52

linshare-ui-upload-request

Vue
4
star
53

esn-frontend-admin

Administration SPA for OpenPaaS
JavaScript
4
star
54

esn-frontend-common-libs

Common ground for OpenPaaS frontend (https://open-paas.org)
JavaScript
4
star
55

obm-deploy

[ARCHIVED] Ansible based OBM deployment system
JavaScript
4
star
56

esn

OpenPaaS web & API server
4
star
57

linshare-plugin-thunderbird

Thunderbird plugin for LinShare
JavaScript
4
star
58

i18n-checker

[ARCHIVED] Validate translation files
JavaScript
4
star
59

hublin-slack-integration

[ARCHIVED] Integrate Hubl.in with Slack.com
JavaScript
4
star
60

linshare-backend-dockerfile

Shell
4
star
61

linagora.esn.admin

Administration module for the ESN
JavaScript
3
star
62

linsign

[ARCHIVED] LinSign – Electronic signature application
Java
3
star
63

linshare-ui-admin-dockerfile

Dockerfile
3
star
64

vtiger-api-js-client

[ARCHIVED] A Javascript client to query vTiger 6 REST API
JavaScript
3
star
65

openpaas-videoconference-app

Videoconference app for OpenPaaS
JavaScript
3
star
66

lng-webdrone

[ARCHIVED] ARDrone + Nodejs + video streaming
HTML
3
star
67

crash-guice

[ARCHIVED] Crash Guice integration module
Java
3
star
68

linshare-api-client

JS library for Linshare APIs
JavaScript
3
star
69

esn-frontend-inbox-calendar

Intermediary frontend module for Calendar Web and Webmail frontend
JavaScript
3
star
70

grunt-docker-spawn

[ARCHIVED] Run docker containers with grunt.
JavaScript
3
star
71

esn-frontend-account-inbox

Intermediary frontend module for Inbox and account
JavaScript
2
star
72

openpaas-mailets

[ARCHIVED]
Java
2
star
73

Lincompliance

CSS
2
star
74

esn-frontend-application-grid

TypeScript
2
star
75

linshare-ui-upload-proposition

JavaScript
2
star
76

esn-frontend-linshare

OpenPaaS' AngularJS module for LinShare
JavaScript
2
star
77

dav-client

TypeScript
2
star
78

linagora-design-flutter

An enterprise-class UI design language and Flutter UI library
Dart
2
star
79

linshare-ui-user-dockerfile

Dockerfile
2
star
80

esn-frontend-calendar-public

Public calendar SPA for OpenPaaS
JavaScript
2
star
81

linagora.esn.unifiedinbox

JavaScript
2
star
82

esn-nginx-dockerfile

[ARCHIVED] nginx container for OpenPaaS ESN
Dockerfile
2
star
83

esn-frontend-inbox-linshare

LinShare plugin for OpenPaaS Unified Inbox module
JavaScript
2
star
84

linagora.esn.calendar

📅 Calendar module for OpenPaaS
JavaScript
2
star
85

TwakeMobileProxy

TypeScript
2
star
86

spews-importer-obm

[ARCHIVED] Tools that read SPEWS specific data, to migrate them to OBM using its provisioning API
TypeScript
2
star
87

openpaas-logo

[ARCHIVED] The OpenPaaS logo, ready to spin
JavaScript
2
star
88

openpaas-doc

OpenPaaS Documentation 🤘🏻
SCSS
2
star
89

contact-update-from-mail

Prediction framework and coupling with OpenPaaS to fetch info from email signature and complete contacts
Java
2
star
90

esn-frontend-mailto-handler

Mailto: links handler, to open them with OpenPaaS webmail
JavaScript
2
star
91

linshare-ui-editor-onlyoffice

Frontend part for LinShare editor tool using OnlyOffice
JavaScript
2
star
92

poc-ejbca-ws-client.java

[ARCHIVED] The Java version of our Ejbca WS client poc
Java
2
star
93

linshare-dockerfile

Official LinShare Docker image
Shell
2
star
94

ogp-flow-proxy

[ARCHIVED]
JavaScript
2
star
95

linshare-thumbnail-engine

Java
2
star
96

vue-openpaas-components

[ARCHIVED] A collection of Vue components to be used by OpenPaaS Vue apps
JavaScript
1
star
97

uds-docker-2

[ARCHIVED] Matériel utilisé lors de la seconde UDS concernant Docker
HTML
1
star
98

esn-elasticsearch-dockerfile

[ARCHIVED] Dockerfile for OpenPaaS ESN Elasticsearch instance
Shell
1
star
99

connect-dynamic-middleware

Allow to change the middleware dynamically in a running connect/express application.
Python
1
star
100

calendar-next-gen

Vue
1
star