msp301 / pinbox

Self-hosted webmail client greatly inspired by Google Inbox

Pinbox

Pinbox is a self-hosted webmail client greatly inspired by Google Inbox.

Warning: Pinbox is in early stages of development and lacks most functionality expected in a webmail client -- Contributions welcome :-)

Prerequisites

• Docker and docker-compose
• notmuch (https://notmuchmail.org/)

Getting started

Hosting your email

Pinbox requires local access to a Maildir directory. A mailbox can be synchronized to a local Maildir using OfflineIMAP or similar. If you wish to try Pinbox with an exported mailbox and have a .mbox file, this file can be converted to a Maildir directory using mb2md.

Before starting Pinbox

Pinbox uses the Notmuch mail indexer to provide fast email access and managing mailbox labels.

Before Pinbox is able to read your Maildir directory notmuch needs to be installed on your system. Run notmuch setup && notmuch new <MAILDIR DIRECTORY> to initialise the notmuch database ready for Pinbox.

Starting Pinbox

Pinbox consists of a single page app to provide the web interface and a server component for handling access to your email.

1. Edit docker-compose.yml to insert the full path of your maildir directory
2. Start all services using: docker-compose up -d
3. Navigate to http://localhost:4200

License

Licensed under AGPL-3.0-or-later

pinbox's Issues

Bundled thread missing sender name

If an email thread contains multiple messages and has been grouped into a bundle in the inbox. When opening the thread, the last message does not show the sender.

To Reproduce

1. Open a bundle within the inbox
2. Open a 3 message thread within bundle
3. The sender for the last message is blank

Expected behavior
The sender name is displayed for all messages within the thread.

Screenshots

Desktop:

• OS: Ubuntu 18.04
• Browser: Chrome
• Version: 75

Add ability to compose an email

Before I can consider using Pinbox, I need to be able to create a new email.

• Clicking on the '+' FAB icon should open an email editor
• Email editor should allow me to set recipient address(es)
• I can send email to the 'pinbox-server' back-end to handle the actual email sending

Make Pinbox a Progressive Web App

It would be good to look into making Pinbox a Progressive Web App (PWA) so it has a good user experience.

If any changes need to be made it would be better to get that done sooner rather than later.

Trouble with install instructions

Describe the bug
Trying to do new install on Ubuntu 22.04

docker-compose up -d
ERROR: Named volume "<PATH_TO_MAILDIR>:/hoem/dev0/mail:rw" is used in service "server" but no declaration was found in the volumes section.

Emails are rendered with unexpected characters

Describe the bug
Sometimes emails include unexpected characters e.g. Hi  is rendered as Hi .

To Reproduce
Steps to reproduce the behavior:

1. Get pinbox-server to return email content including Hi  in a HTML email
2. View content through Pinbox UI
3. Unexpected Â gets included

Expected behavior
Email content to match the text as is in the email: Hi 

Desktop (please complete the following information):

• OS: Ubuntu 18.04
• Browser: Chrome
• Version: 75.0.3770.100

Additional context
This feels like some form of white-space issue or similar.
Just reading in a small assortment of real emails should trigger the issue, as it seems fairly common for me.