aerc is an email client for your terminal.
This is a fork of the original aerc by Drew DeVault.
A short demonstration can be found on https://aerc-mail.org/
Join the IRC channel: #aerc on irc.libera.chat for end-user support, and development.
On its first run, aerc will copy the default config files to
on Linux or
~/Library/Preferences/aerc on MacOS (or
$XDG_CONFIG_HOME/aerc if set)
and show the account configuration wizard.
If you redirect stdout to a file, logging output will be written to that file:
$ aerc > log
Note that the example HTML filter (off by default), additionally needs
dante to be installed.
Also available as man pages:
User contributions and integration with external tools:
Recent versions of aerc are available on:
And likely other platforms.
Install the dependencies:
Then compile aerc:
aerc optionally supports notmuch. To enable it, you need to have a recent version of notmuch, including the header files (notmuch.h). Then compile aerc with the necessary build tags:
$ GOFLAGS=-tags=notmuch make
To install aerc locally:
# make install
By default, aerc will install config files to directories under
and will search for templates and stylesets in these locations in order:
At build time it is possible to add an extra location to this list and to use
that location as the default install location for config files by setting the
PREFIX option like so:
# make PREFIX=/custom/location # make install PREFIX=/custom/location
This will install templates and other config files to
and man pages to
/custom/location/share/man. This extra location will have lower
priority than the XDG locations but higher than the fixed paths.
Anyone can contribute to aerc. First you need to clone the repository and build the project:
$ git clone https://git.sr.ht/~rjarry/aerc $ cd aerc $ make
Patch the code. Make some tests. Ensure that your code is properly formatted with gofmt. Ensure that everything builds and works as expected. Ensure that you did not break anything.
make lintif notmuch is not available on your system you may have to edit
.golangci.tomland disable the notmuch tag. Otherwise you could get hard to trace false positives
Once you are happy with your work, you can create a commit (or several commits). Follow these general rules:
git log --oneline.
Fixes:trailer with the commit id and its title.
There is a great reference for commit messages in the Linux kernel documentation.
IMPORTANT: you must sign-off your work using
git commit --signoff. Follow the
Linux kernel developer's certificate of origin for more
details. All contributions are made under the MIT license. If you do not want
to disclose your real name, you may sign-off using a pseudonym. Here is an
Signed-off-by: Robin Jarry <firstname.lastname@example.org>
Before sending the patch, you should configure your local clone with sane defaults:
$ git config format.subjectPrefix "PATCH aerc" $ git config sendemail.to "~email@example.com"
And send the patch to the mailing list:
$ git send-email --annotate -1
Before your patch can be applied, it needs to be reviewed and approved by others. They will indicate their approval by replying to your patch with a Tested-by, Reviewed-by or Acked-by trailer. For example:
Acked-by: Robin Jarry <firstname.lastname@example.org>
There is no "chain of command" in aerc. Anyone that feels comfortable enough to "ack" or "review" a patch should express their opinion freely with an official Acked-by or Reviewed-by trailer. If you only tested that a patch works as expected but did not conduct a proper code review, you can indicate it with a Tested-by trailer.
You can follow the review process via email and on the web ui.
Wait for feedback. Address comments and amend changes to your original commit. Then you should send a v2 (and maybe a v3, v4, etc.):
$ git send-email --annotate -v2 -1
Be polite, patient and address all of the reviewers' remarks. If you disagree with something, feel free to discuss it.
Once your patch has been reviewed and approved (and if the maintainer is OK with it), it will be applied and pushed.
Ask for support or follow general discussions on ~email@example.com.
Send patches and development related questions to ~firstname.lastname@example.org.
Instructions for preparing a patch are available at git-send-email.io
Subscribe to release announcements on ~email@example.com
Submit confirmed bug reports and confirmed feature requests on https://todo.sr.ht/~rjarry/aerc.