Mail-in-a-Box with Quotas

This is an experimental implementation of Mail-in-a-box with quota support.

Quotas can be set and viewed in the control panel

To set quotas from the command line, use:

tools/mail.py user quota <email> <quota>

To set the system default quota for new users, use:

tools/mail.py system default-quota <quota>

Mailbox size recalculation by Dovecot can be forced using the command:

doveadm quota recalc -A

Please report any bugs on github.

Installing v5x-quota

To install the latest version, log into your box and execute the following commands:

$ git clone https://github.com/jrsupplee/mailinabox.git
$ cd mailinabox
$ sudo bash setup/bootstrap.sh

Follow the standard directions for setting up an MiaB installation. There are no special installation steps for installing this version.

The default quota is set to 0 which means unlimited. If you want to set a different default quota, follow the directions above.

Upgrading v5x to v5x-quota

This is experimental software. You have been warned.

• Rename your mailinabox directory to something like miab.old

• Clone this repository using:

  git clone https://github.com/jrsupplee/mailinabox.git

• cd into mailinabox and run sudo bash setup/bootstrap.sh On occasion there are lock errors when updating Munin. Just re-run sudo setup/start.sh until the error does not occur.

• Note: all existing users at the time of the upgrade will have there quota set to 0 (unlimited).

Upgrading MiaB with quotas to a New Version

• cd into the mailinabox directory.

• Execute git pull to download the latest changes.

• Execute sudo bash setup/bootstrap.sh to checkout the latest version and re-run setup.

Issues

• When a user's quota is changed, any IMAP session running for that user will not recognize the new quota. To solve this a dovecot reload could be issued causing all current IMAP sessions to be terminated. On a system with many users, it might not be desirable to reset all users sessions to fix the quota for one user. Also if the administrator is setting the quota for several users it would result in the continual reset of those connections.

• API docs do not include the quota endpoints. Quota API endpoints need to be added to api/mainlinabox.yml.

Changes

v57a-quota-0.22-beta

• Update to v57a of Mail-in-a-Box

v56-quota

• Update to v56 of Mail-in-a-Box

v0.55-quota-0.22-beta

• Update to v55 of Mail-in-a-Box

v0.53-quota-0.22-beta

• Update to v0.53 of Mail-in-a-Box

v0.52-quota-0.22-beta

• Update to v0.52 of Mail-in-a-Box

v0.51-quota-0.22-beta

• Update to v0.51 of Mail-in-a-Box

v0.50-quota-0.22-beta

• Update to v0.50 of Mail-in-a-Box

v0.48-quota-0.22-beta

• Update to v0.48 of Mail-in-a-Box

v0.46-quota-0.22-beta

• Update to v0.46 of Mail-in-a-Box

v0.45-quota-0.22-beta

• Update to v0.45 of Mail-in-a-Box

v0.44-quota-0.22-beta

• Update to v0.44 of Mail-in-a-Box

v0.43-quota-0.22-beta

• Fix bug that crashed user list when there is an archived user.

v0.43-quota-0.21-beta

• Remove extra features from the master branch

v0.43-quota-0.20-beta

• Hide set quota for a mailbox that has been archived

v0.43-quota-0.19-beta

• Add user quota API documentation to the mail users page

v0.43-quota-0.18-beta

• Update to v0.43 of Mail-in-a-Box

v0.42b-quota-0.18-beta

• Update to v0.42b of Mail-in-a-Box

v0.41-quota-0.18-beta

• Bump version to add a new annotated tag. The last version had a plain tag which is not seen when checking for the latest version.

v0.41-quota-0.17-beta

• Change status of project to beta. No changes to the code

v0.41-quota-0.17-alpha

• Update the README

v0.41-quota-0.16-alpha

• Update to v0.41 of Mail-in-a-Box

v0.40-quota-0.16-alpha

• Fix problem with quota field on control panel that prevented adding users.

v0.40-quota-0.15-alpha

• Fix bug where quotas are not recalculated when a user's quota is changed in control panel

v0.40-quota-0.14-alpha

• When updating a user's quota, execute doveadm quota recalc -u <email> to forces an immediate recalculation of the user's quota.

• Add a thousands separator (,) to the messages count in the control panel user list.

• Execute doveadm quota recalc -A to force a recalculation of all user quotas when running start.sh.

• Get rid of the error message complaining that the quota column already exists when upgrading from a previous version of v0.40-quota.

v0.40-quota-0.13-alpha

• Add a default-quota setting in settings.yaml.

• Add input for setting quota when entering a new user in control panel.

• Modify tools/mail.py to allow for setting and getting the default system quota.

• Modify tools/mail.py to allow for getting a user's quota setting.

• Modify the mail users list in control panel to display percentage of quota used.

v0.40-quota-0.12-alpha

• Update README

v0.40-quota-0.11-alpha

• Read latest version from this repository not the Mail-in-a-Box master repository

v0.40-quota-0.1-alpha

• First experimental release of Mail-in-a-Box for quotas.
• Quotas are working and there is basic support in the control panel and tools/mail.py.

Reference Documents

• https://blog.sys4.de/postfix-dovecot-mailbox-quota-en.html
• https://linuxize.com/post/install-and-configure-postfix-and-dovecot/

BEGIN Official README]

Mail-in-a-Box
=============

By [@JoshData](https://github.com/JoshData) and [contributors](https://github.com/mail-in-a-box/mailinabox/graphs/contributors).

Mail-in-a-Box helps individuals take back control of their email by defining a one-click, easy-to-deploy SMTP+everything else server: a mail server in a box.

**Please see [https://mailinabox.email](https://mailinabox.email) for the project's website and setup guide!**

* * *

Our goals are to:

* Make deploying a good mail server easy.
* Promote [decentralization](http://redecentralize.org/), innovation, and privacy on the web.
* Have automated, auditable, and [idempotent](https://web.archive.org/web/20190518072631/https://sharknet.us/2014/02/01/automated-configuration-management-challenges-with-idempotency/) configuration.
* **Not** make a totally unhackable, NSA-proof server.
* **Not** make something customizable by power users.

Additionally, this project has a [Code of Conduct](CODE_OF_CONDUCT.md), which supersedes the goals above. Please review it when joining our community.


In The Box
----------

Mail-in-a-Box turns a fresh Ubuntu 22.04 LTS 64-bit machine into a working mail server by installing and configuring various components.

It is a one-click email appliance. There are no user-configurable setup options. It "just works."

The components installed are:

* SMTP ([postfix](http://www.postfix.org/)), IMAP ([Dovecot](http://dovecot.org/)), CardDAV/CalDAV ([Nextcloud](https://nextcloud.com/)), and Exchange ActiveSync ([z-push](http://z-push.org/)) servers
* Webmail ([Roundcube](http://roundcube.net/)), mail filter rules (thanks to Roundcube and Dovecot), and email client autoconfig settings (served by [nginx](http://nginx.org/))
* Spam filtering ([spamassassin](https://spamassassin.apache.org/)) and greylisting ([postgrey](http://postgrey.schweikert.ch/))
* DNS ([nsd4](https://www.nlnetlabs.nl/projects/nsd/)) with [SPF](https://en.wikipedia.org/wiki/Sender_Policy_Framework), DKIM ([OpenDKIM](http://www.opendkim.org/)), [DMARC](https://en.wikipedia.org/wiki/DMARC), [DNSSEC](https://en.wikipedia.org/wiki/DNSSEC), [DANE TLSA](https://en.wikipedia.org/wiki/DNS-based_Authentication_of_Named_Entities), [MTA-STS](https://tools.ietf.org/html/rfc8461), and [SSHFP](https://tools.ietf.org/html/rfc4255) policy records automatically set
* TLS certificates are automatically provisioned using [Let's Encrypt](https://letsencrypt.org/) for protecting https and all of the other services on the box
* Backups ([duplicity](http://duplicity.nongnu.org/)), firewall ([ufw](https://launchpad.net/ufw)), intrusion protection ([fail2ban](http://www.fail2ban.org/wiki/index.php/Main_Page)), and basic system monitoring ([munin](http://munin-monitoring.org/))

It also includes system management tools:

* Comprehensive health monitoring that checks each day that services are running, ports are open, TLS certificates are valid, and DNS records are correct
* A control panel for adding/removing mail users, aliases, custom DNS records, configuring backups, etc.
* An API for all of the actions on the control panel

Internationalized domain names are supported and configured easily (but SMTPUTF8 is not supported, unfortunately).

It also supports static website hosting since the box is serving HTTPS anyway. (To serve a website for your domains elsewhere, just add a custom DNS "A" record in you Mail-in-a-Box's control panel to point domains to another server.)

For more information on how Mail-in-a-Box handles your privacy, see the [security details page](security.md).


Installation
------------

See the [setup guide](https://mailinabox.email/guide.html) for detailed, user-friendly instructions.

For experts, start with a completely fresh (really, I mean it) Ubuntu 22.04 LTS 64-bit machine. On the machine...

Clone this repository and checkout the tag corresponding to the most recent release:

	$ git clone https://github.com/mail-in-a-box/mailinabox
	$ cd mailinabox
	$ git checkout v68

Begin the installation.

	$ sudo setup/start.sh

The installation will install, uninstall, and configure packages to turn the machine into a working, good mail server.

For help, DO NOT contact Josh directly --- I don't do tech support by email or tweet (no exceptions).

Post your question on the [discussion forum](https://discourse.mailinabox.email/) instead, where maintainers and Mail-in-a-Box users may be able to help you.

Note that while we want everything to "just work," we can't control the rest of the Internet. Other mail services might block or spam-filter email sent from your Mail-in-a-Box.
This is a challenge faced by everyone who runs their own mail server, with or without Mail-in-a-Box. See our discussion forum for tips about that.


Contributing and Development
----------------------------

Mail-in-a-Box is an open source project. Your contributions and pull requests are welcome. See [CONTRIBUTING](CONTRIBUTING.md) to get started.


The Acknowledgements
--------------------

This project was inspired in part by the ["NSA-proof your email in 2 hours"](http://sealedabstract.com/code/nsa-proof-your-e-mail-in-2-hours/) blog post by Drew Crawford, [Sovereign](https://github.com/sovereign/sovereign) by Alex Payne, and conversations with <a href="https://twitter.com/shevski" target="_blank">@shevski</a>, <a href="https://github.com/konklone" target="_blank">@konklone</a>, and <a href="https://github.com/gregelin" target="_blank">@GregElin</a>.

Mail-in-a-Box is similar to [iRedMail](http://www.iredmail.org/) and [Modoboa](https://github.com/tonioo/modoboa).


The History
-----------

* In 2007 I wrote a relatively popular Mozilla Thunderbird extension that added client-side SPF and DKIM checks to mail to warn users about possible phishing: [add-on page](https://addons.mozilla.org/en-us/thunderbird/addon/sender-verification-anti-phish/), [source](https://github.com/JoshData/thunderbird-spf).
* In August 2013 I began Mail-in-a-Box by combining my own mail server configuration with the setup in ["NSA-proof your email in 2 hours"](http://sealedabstract.com/code/nsa-proof-your-e-mail-in-2-hours/) and making the setup steps reproducible with bash scripts.
* Mail-in-a-Box was a semifinalist in the 2014 [Knight News Challenge](https://www.newschallenge.org/challenge/2014/submissions/mail-in-a-box), but it was not selected as a winner.
* Mail-in-a-Box hit the front page of Hacker News in [April](https://news.ycombinator.com/item?id=7634514) 2014, [September](https://news.ycombinator.com/item?id=8276171) 2014, [May](https://news.ycombinator.com/item?id=9624267) 2015, and [November](https://news.ycombinator.com/item?id=13050500) 2016.
* FastCompany mentioned Mail-in-a-Box a [roundup of privacy projects](http://www.fastcompany.com/3047645/your-own-private-cloud) on June 26, 2015.