0.0.1 • Published 5 years ago

void-mail v0.0.1

Weekly downloads
-
License
-
Repository
-
Last release
5 years ago

a self-hosted, simple and fast disposable mail service that works directly with your imap server. No database required.

Build Status XO code style FOSSA Status

How it works

You need a domain with catch-all-mailbox and an imap account.

Your run the void-mail nodejs application on your own server. It will automatically load all mails from the imap server.

When the user opens the void-mail web application, he/she can read the mails corresponding to a specific address.

See FAQ

Features

  • Push-Notification on new emails.
  • Mail presentation are sanitized to avoid tracking.
  • In-Memory cache for very fast mail access.
  • No database required! You just need a catch-all-mailbox imap server.
  • Deletes emails older than X days.

Install

One click installation: Deploy

See Installation

Configuration Parameters

These are all set as environment variables. They are loaded in config.js

ParameterTypeDescription
DOMAINStringThe domain part after the @, where your receive emails. (e.g. example.com)
IMAP_SERVERStringThe imap server address. (e.g. imap.example.com)
IMAP_USERStringThe username used to sign into the imap server.
IMAP_PASSWORDStringThe password used to sign into the imap server.
IMAP_REFRESH_INTERVAL_SECONDSIntegerHow often to check for new messages on the imap server. (default: undefined) Usually the application reacts immediately to new arrived mail.
PORTIntegerOn which port to run the http interface. (default: 3000)
DELETE_MAILS_OLDER_THAN_DAYSIntegerHow many days to to wait before deleting messages. (default: 30)
DEBUGStringEnable debug logging with value void-mail:* (default: disabled)

TODO

This mostly works, but some things need to be done:

Testing:

  • create unit/integration tests

Maybe Later:

Team

Aravindo Wingeier

Aravindo Wingeier

License

GPL-3.0 © Aravindo Wingeier