aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTim Culverhouse <tim@timculverhouse.com>2023-04-30 12:56:10 -0500
committerRobin Jarry <robin@jarry.cc>2023-05-16 17:07:50 +0200
commit6b6aaf3ae131971d05ab3f849ea3db14c6a6e055 (patch)
tree00f9055556388cf1396af6da84ef0b5b59814efe /doc
parente8089e7d8f6065031814bf7d80be043536e09fe7 (diff)
downloadaerc-6b6aaf3ae131971d05ab3f849ea3db14c6a6e055.tar.gz
headers: enable partial header fetching
Enable partial header fetching by creating config values for headers to specifically include, or specifically exclude. The References field will always be fetched, regardless of the include list. Envelope data is always fetched, but is not shown with :toggle-headers, since it isn't in the RFC822 struct unless explicitly included in the list. Partial headers can break the cache on changes. Update the cache tag key to include the state of the partially-fetched headers. Partial header fetching can have a significant performance increase for IMAP, and for all backends a resource improvement. Some data to support this is below. Gathered by opening aerc, selecting a mailbox with approximately 800 messages and scrolling to the end. Received measured with nethogs, RAM from btop Received | RAM ------------------------------------- All Headers | 9,656 kb | 103 MB Minimum Headers | 896 kb | 36 MB Signed-off-by: Tim Culverhouse <tim@timculverhouse.com> Acked-by: Moritz Poldrack <moritz@poldrack.dev> Acked-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-accounts.5.scd24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/aerc-accounts.5.scd b/doc/aerc-accounts.5.scd
index fdf10b76..8fa48647 100644
--- a/doc/aerc-accounts.5.scd
+++ b/doc/aerc-accounts.5.scd
@@ -88,6 +88,30 @@ Note that many of these configuration options are written for you, such as
use *aerc-sendmail*(5) in combination with *msmtp*(1) and
*--read-envelope-from*.
+*headers* = _<header1,header2,header3...>_
+ Specifies the comma separated list of headers to fetch with the message.
+
+ By default, all headers are fetched. If any headers are specified in this
+ list, aerc will append it to the following list of required headers:
+
+ - date
+ - subject
+ - from
+ - sender
+ - reply-to
+ - to
+ - cc
+ - bcc
+ - in-reply-to
+ - message-id
+ - references
+
+*headers-exclude* = _<header1,header2,header3...>_
+ Specifies the comma separated list of headers to exclude from fetching.
+ Note that this overrides anything from *headers*.
+
+ By default, no headers are excluded.
+
*outgoing* = _<uri>_
Specifies the transport for sending outgoing emails on this account. It
should be a connection string, and the specific meaning of each component