aerc/doc/aerc-maildir.5.scd
Tim Culverhouse 2551dd1bfa feat: add background mail polling option for all workers
Check for new mail (recent, unseen, exists counts) with an external
command, or for imap with the STATUS command, at start or on
reconnection and every X time duration

IMAP:
The selected folder is skipped, per specification. Additional config
options are included for including/excluding folders explicitly.

Maildir/Notmuch:
An external command will be run in the background to check for new mail.
An optional timeout can be used with maildir/notmuch. Default is 10s

New account options:
check-mail
check-mail-cmd (maildir/notmuch only)
check-mail-timeout (maildir/notmuch only), default 10s
check-mail-include (IMAP only)
check-mail-exclude (IMAP only)

If unset, or set less than or equal to 0, check-mail will be ignored

Signed-off-by: Tim Culverhouse <tim@timculverhouse.com>
Tested-by: Moritz Poldrack <moritz@poldrack.dev>
Acked-by: Robin Jarry <robin@jarry.cc>
2022-05-31 14:32:51 +02:00

55 lines
1.3 KiB
Markdown

aerc-maildir(5)
# NAME
aerc-maildir - maildir configuration for *aerc*(1)
# SYNOPSIS
aerc implements the maildir format.
# CONFIGURATION
Maildir accounts currently are not supported with the :new-account command and
must be added manually to the *aerc-config*(5) file.
The following maildir-specific options are available:
*check-mail-cmd*
Command to run in conjunction with *check-mail* option.
Example:
mbsync -a
Default: none
*check-mail-timeout*
Timeout for the *check-mail-cmd*. The command will be stopped if it does
not complete in this interval and an error will be displayed. Increase from
the default if repeated errors occur
Default: 10s
*source*
maildir://path
The *source* indicates the path to the directory containing your maildirs
rather than one maildir specifically.
The path portion of the URL following _maildir://_ must be either an absolute
path prefixed by */* or a path relative to your home directory prefixed with
*~*. For example:
source = maildir:///home/me/mail
source = maildir://~/mail
# SEE ALSO
*aerc*(1) *aerc-config*(5) *aerc-smtp*(5) *aerc-notmuch*(5)
# AUTHORS
Originally created by Drew DeVault <sir@cmpwn.com> and maintained by Robin
Jarry <robin@jarry.cc> who is assisted by other open source contributors. For
more information about aerc development, see https://sr.ht/~rjarry/aerc/.