aboutsummaryrefslogtreecommitdiffstats
path: root/doc
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
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')
-rw-r--r--doc/aerc-config.5.scd14
-rw-r--r--doc/aerc-imap.5.scd15
-rw-r--r--doc/aerc-maildir.5.scd15
-rw-r--r--doc/aerc-notmuch.5.scd15
4 files changed, 59 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 79025508..b7fba82d 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -525,6 +525,20 @@ Note that many of these configuration options are written for you, such as
Default: Archive
+*check-mail*
+ Specifies an interval to check for new mail. Mail will be checked at
+ startup, and every interval. IMAP accounts will check for mail in all
+ unselected folders, and the selected folder will continue to receive PUSH
+ mail notifications. Maildir/Notmuch folders must use *check-mail-cmd* in
+ conjunction with this option. See *aerc-maildir* and *aerc-notmuch* for
+ more information.
+
+ Setting this option to 0 will disable check-mail
+
+ Example: 5m
+
+ Default: 0
+
*copy-to*
Specifies a folder to copy sent mails to, usually "Sent".
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd
index 5a20749a..99640b64 100644
--- a/doc/aerc-imap.5.scd
+++ b/doc/aerc-imap.5.scd
@@ -96,6 +96,21 @@ available:
This option is only supported on linux. On other platforms, it will be
ignored.
+*check-mail-include*
+ Specifies the comma separated list of folders to include when checking for
+ new mail with *check-mail*. Names prefixed with ~ are interpreted as regular
+ expressions.
+
+ Default: all folders
+
+*check-mail-exclude*
+ Specifies the comma separated list of folders to exclude when checking for
+ new mail with *check-mail*. Names prefixed with ~ are interpreted as regular
+ expressions.
+ Note that this overrides anything from *check-mail-include*.
+
+ Default: no folders
+
# SEE ALSO
*aerc*(1) *aerc-config*(5)
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
diff --git a/doc/aerc-notmuch.5.scd b/doc/aerc-notmuch.5.scd
index a411c51f..44b6b9d2 100644
--- a/doc/aerc-notmuch.5.scd
+++ b/doc/aerc-notmuch.5.scd
@@ -20,6 +20,21 @@ must be added manually.
In accounts.conf (see *aerc-config*(5)), the following notmuch-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*
notmuch://path