aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJason Cox <me@jasoncarloscox.com>2023-10-29 17:40:48 -0400
committerRobin Jarry <robin@jarry.cc>2023-11-02 11:59:39 +0100
commitfaa879f9a84d44f9b251410fc923a827a44df1a7 (patch)
tree91f0a718e58b88d41a9a2c0720389bfcc137516a /doc
parent31b50f24d51fd429f30e20fb42a5681149e5bfe7 (diff)
downloadaerc-faa879f9a84d44f9b251410fc923a827a44df1a7.tar.gz
hooks: add mail-added hook
The mail-added hook runs whenever a message is added to a folder. Note that the hook does not run when a new message is received (the mail-received hook already covers that) but instead runs whenever aerc itself adds a message to a folder, e.g. when moving or copying a message. Changelog-added: `mail-added` hook that triggers when a message is added to a folder. References: https://todo.sr.ht/~rjarry/aerc/136 Signed-off-by: Jason Cox <me@jasoncarloscox.com> Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-config.5.scd15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd
index 200c0609..34bfb882 100644
--- a/doc/aerc-config.5.scd
+++ b/doc/aerc-config.5.scd
@@ -971,6 +971,21 @@ They are configured in the *[hooks]* section of aerc.conf.
*mail-deleted* = _mbsync "$AERC_ACCOUNT:$AERC_FOLDER"_
+*mail-added* = _<command>_
+ Executed when a message is added to a folder. Note that this hook is not
+ triggered when a new message is received (use *mail-received* for that) but
+ rather is only triggered when aerc itself adds a message to a folder, e.g.
+ when moving or copying a message.
+
+ Variables:
+
+ - *AERC_ACCOUNT*
+ - *AERC_FOLDER*
+
+ Example:
+
+ *mail-added* = _mbsync "$AERC_ACCOUNT:$AERC_FOLDER"_
+
*aerc-shutdown* = _<command>_
Executed when aerc shuts down. Aerc will wait for the command to finish
before exiting.