earaujoassis / postal

📮 A security- and privacy-first, mobile-first, and offline-first mail service application

Postal

A security- and privacy-first, mobile-first, and offline-first mail service application

The Postal application is based on the AWS SES and S3 technologies/services in order to create an email application. AWS SES stores encrypted MIME messages in a S3 bucket (messages are checked by default to address spams and viruses); the Postal application obtains those messages and handles it inside the application. Email messages are also sent through the AWS SES infrastructure. The application also supports encrypting and decrypting messages.

The application is using Play + Java on the back-end and Vuejs + Vuex + TypeScript + LESS on the front-end. It also uses a Vault scheme to store application configuration settings.

Setup & Running

Please make sure to install Java 8+, Gradle, SBT, Node.js (Postal is developed over version 14.16.0), and Yarn. Also, you must create a conf/secrets.conf file according to the template configuration in conf/secrets.sample.conf to connect to a Vault k/v secret. The secret has the same format as the conf/config.local.sample.json file. You may create a conf/config.local.json if you don't want to use the Vault solution, following the structure defined by the template file (conf/config.local.sample.json). Once those requirements are complete, you may run the following commands to start the development server:

$ yarn install && yarn build
$ sbt run

Deployment using Docker

First, you must create a conf/secrets.conf file according to the template configuration in conf/secrets.sample.conf to connect to a Hashicorp's Vault k/v secret. The secret has the same format as the conf/config.local.sample.json file. You may create a conf/config.local.json if you don't want to use the Vault solution, following the structure defined by the template file (conf/config.local.sample.json). Once those requirements are complete, you may run the following command to build and start the application through Docker containers:

$ binstubs/deploy.sh

It will create the PostgreSQL container and the Postal container (through docker-compose). The application should be available at http://{docker-hostname-or-ip}:8585.

Build intermediary image

$ docker build --file Dockerfile.openjdk-sbt -t earaujoassis/openjdk-sbt .
$ docker tag earaujoassis/openjdk-sbt ${PRIVATE_REGISTRY_URL}/openjdk-sbt:latest
$ docker push ${PRIVATE_REGISTRY_URL}/openjdk-sbt:latest

Issues

Please take a look at /issues

License

MIT License © Ewerton Assis

postal's Issues

Connect to Apple iCloud SMTP provider

Receive and send e-mail messages from an iCloud account

Create a user metadata for AWS/SES

Retrieve email messages from a AWS/S3 Bucket (which receives messages from AWS/SES).

When creating a new user and a new user_session, the user_id is null

ERROR: null value in column "user_id" violates not-null constraint

at repositories.UserSessionRepository.insert(UserSessionRepository.java:65)
at controllers.HomeController.callback(HomeController.java:108)

Save the e-mail messages inside a instance of Tahoe-LAFS

Resources:

• https://tahoe-lafs.org/~warner/pycon-tahoe.html
• https://tahoe-lafs.org/trac/tahoe-lafs

Delete email message permanently

Acceptance criteria

• once a message is in trash, provide a way to delete it permanently; and
• message must be delete permanently from service provider or remote storage.

Create a settings interface

As a user, I'd like to provide information/settings to retrieve email messages from an external provider.

Acceptance criteria:

• settings page
• user can provide information to access external providers
• email messages are obtained from external providers according to those settings/information

Setup the mail server and document it

The mail server should be setup and a script or a README.md file should be created in order to replicate that.

Resources:

• https://www.digitalocean.com/community/tutorials/how-to-configure-a-mail-server-using-postfix-dovecot-mysql-and-spamassassin
• https://mailinabox.email/
• http://jeffreifman.com/how-to-install-your-own-private-e-mail-server-in-the-amazon-cloud-aws/
• http://arstechnica.com/information-technology/2014/02/how-to-run-your-own-e-mail-server-with-your-own-domain-part-1/
• https://www.linode.com/docs/email/running-a-mail-server
• https://www.linode.com/docs/email/

Provide feedback whenever the Settings page is saved

Create pagination scheme

Acceptance criteria

• once in a folder, select pages to display (10 items per page); and
• once the folder is opened again, get back to page 1.

Prepare a mobile version of the website

Resources:

• http://hammerjs.github.io/
• https://apeatling.com/2014/11/javascript-pull-to-refresh-web/

Connect to Google Gmail SMTP provider

Receive and send e-mail messages from a Gmail account

Protect the API from SQL injection

Do not trust data from any source (including a trustworthy one)

Create user authentication/authorization middleware

Connect to Fastmail SMTP provider

Receive and send e-mail messages from a Fastmail account

Sign-up & sign-in through earaujoassis/space

The user should be able to Sign-up and Sign-in through the earaujoassis/space integration.

Create initial setup

There should exist a whole setup for this project and it should be as secure as possible! I'm planning to use Scala for the back-end and probably Elm for the front-end.

Resources:

• https://github.com/brunch/brunch-guide#readme
• https://changelog.com/posts/elm-functional-front-end-development-and-why-you-should-care
• https://github.com/isRuslan/awesome-elm
• https://www.sitepoint.com/functional-reactive-programming-elm-introduction/
• http://futurice.com/blog/elm-in-the-real-world
• https://guide.elm-lang.org/install.html
• https://www.elm-tutorial.org/en/01-foundations/01-hello.html
• https://www.playframework.com/documentation/2.5.x/Tutorials