bleemayer/dovel repository overview

_________                 ______         
______  /________   _________  /         
_  __  /_  __ \_ | / /  _ \_  /          
/ /_/ / / /_/ /_ |/ //  __/  /           
\__,_/  \____/_____/ \___//_/   ________ 
                               |   ~~ # |
                               |  ---   |
                               '--------'

Dovel is a SMTP server that sends and receives emails acording to a simple configuration file. It also comes with an optional web interface that you can use to browse your emails. It is designed to be simple and easy to use, and will remain so. Dovel is great because:

• Is lightweight: Uses only a few MBs of RAM and loads pages super fast.
• Is easy to configure: Needs just one JSON file.
• Is easy to use: The design is simple and extensible.
• Supports DKIM
• Supports PGP using the WKD standard

This project is under the BSD-3-Clause license, its code can be found in our git repositories⁠.

⁠Configuring

The following configuration is enought to receive emails: Dovel needs the file ~/.config/dovel/config.json is order to work correctly, otherwise it will use default settings which may not suit you. The field vaultFile is optional for receiving emails.

{
        "port": "8000",
        "domain": "dovel.email",
        "vaultFile": "users.json"
}

Now the hook must be placed: suppose your domain is dovel.email, emails addressed to [email protected]⁠ will be handled by a hook named receive-dovel.email and emails sent by this domain are handled by send-dovel.email likewise.

So, to enable a domain, simply create the according script. To see all options please refer to the go docs⁠.

⁠Hooks

Dovel can handle email for different domains, so you can have multiple inboxes. To achieve this handler files must be created in the ~/.config/dovel/hooks/ folder. The program will run the corresponding hook passing the email as standard input.

Dovel has some usefull hooks in the hooks⁠ repository:

• receive-example.domain