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.
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.
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).
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.
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
.
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
.
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.
tools/mail.py
.[BEGIN Official README]
By @JoshData and 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 for the project's website and setup guide!
Our goals are to:
Additionally, this project has a Code of Conduct, which supersedes the goals above. Please review it when joining our community.
Mail-in-a-Box turns a fresh Ubuntu 18.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:
It also includes system management tools:
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.
See the setup guide for detailed, user-friendly instructions.
For experts, start with a completely fresh (really, I mean it) Ubuntu 18.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 v57a
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 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.
Mail-in-a-Box is an open source project. Your contributions and pull requests are welcome. See CONTRIBUTING to get started.
This project was inspired in part by the "NSA-proof your email in 2 hours" blog post by Drew Crawford, Sovereign by Alex Payne, and conversations with @shevski, @konklone, and @GregElin.
Mail-in-a-Box is similar to iRedMail and Modoboa.