Fork of the aerc email client (https://sr.ht/~rjarry/aerc)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Robin Jarry 14ceca3200 address-book-cmd: be more lenient with errors 1 month ago
.builds go: bumped minimum required version 1.16 4 months ago
.github/workflows builds: add gnupg in preparation of gpg integration 8 months ago
commands envelope: display message envelope info 1 month ago
completer address-book-cmd: be more lenient with errors 1 month ago
config threads: reverse thread ordering 1 month ago
contrib git-stats.sh: strip trailing white space 2 months ago
doc threads: reverse thread ordering 1 month ago
filters colorize: make it compatible with BSD awk 2 months ago
lib threads: reverse thread ordering 1 month ago
logging aerc: add build info to version string 4 months ago
models msgpart: factorize mime type and filename construction 2 months ago
templates compose: add default template for new messages 11 months ago
widgets msglist: display reversed thread ordering 1 month ago
worker notmuch: move new maildir files to cur upon opening a folder 1 month ago
.editorconfig doc: add contribution guidelines including code style 4 months ago
.gitignore gitignore: ignore race.log.* 2 months ago
.golangci.toml lint: add golangci-lint to the linters 4 months ago
.mailmap Add git mailmap 5 months ago
CHANGELOG.md threads: reverse thread ordering 1 month ago
CONTRIBUTING.md contributing: refine commit message rules 4 months ago
LICENSE LICENSE: add license name 10 months ago
MAINTAINERS Add MAINTAINERS file 2 months ago
Makefile Release version 0.13.0 2 months ago
README.md readme: make contribution section more obvious 4 months ago
aerc.go aercmsg: add AercFuncMsg and QueueFunc 2 months ago
go.mod terminal: bump tcell-term version 2 months ago
go.sum terminal: bump tcell-term version 2 months ago
tools.go restore compatibility with Go 1.16 4 months ago

README.md

aerc

builds.sr.ht status GitHub macOS CI status

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.

Usage

On its first run, aerc will copy the default config files to ~/.config/aerc 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 w3m and dante to be installed.

Documentation

Also available as man pages:

User contributions and integration with external tools:

Installation

Binary Packages

Recent versions of aerc are available on:

And likely other platforms.

From Source

Install the dependencies:

  • go (>=1.16) (Go versions are supported until their end-of-life; support for older versions may be dropped at any time due to incompatibilities or newer required language features.)
  • scdoc

Then compile aerc:

$ make

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 /usr/local/aerc, and will search for templates and stylesets in these locations in order:

  • ${XDG_CONFIG_HOME:-~/.config}/aerc
  • ${XDG_DATA_HOME:-~/.local/share}/aerc
  • /usr/local/share/aerc
  • /usr/share/aerc

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 /custom/location/share/aerc, 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.

Contributing

Anyone can contribute to aerc. Please refer to the contribution guidelines

Resources

Ask for support or follow general discussions on ~rjarry/aerc-discuss@lists.sr.ht.

Send patches and development related questions to ~rjarry/aerc-devel@lists.sr.ht.

Instructions for preparing a patch are available at git-send-email.io

Subscribe to release announcements on ~rjarry/aerc-announce@lists.sr.ht

Submit confirmed bug reports and confirmed feature requests on https://todo.sr.ht/~rjarry/aerc.

License.

Change log.