aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-maildir.5.scd
diff options
context:
space:
mode:
authorTim Culverhouse <tim@timculverhouse.com>2022-05-30 07:34:18 -0500
committerRobin Jarry <robin@jarry.cc>2022-05-31 14:32:51 +0200
commit2551dd1bfa2c68a6ba8644a0c45b24fce8874674 (patch)
treeed752720e1a08708505fd9574b49629d5df84997 /doc/aerc-maildir.5.scd
parent30d57889741cfa8284eec9b32b29144fe01002a2 (diff)
downloadaerc-2551dd1bfa2c68a6ba8644a0c45b24fce8874674.tar.gz
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>
Diffstat (limited to 'doc/aerc-maildir.5.scd')
-rw-r--r--doc/aerc-maildir.5.scd15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/aerc-maildir.5.scd b/doc/aerc-maildir.5.scd
index 7f6e7ccd..80bc0931 100644
--- a/doc/aerc-maildir.5.scd
+++ b/doc/aerc-maildir.5.scd
@@ -15,6 +15,21 @@ 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