about summary refs log tree commit diff stats
path: root/doc/aerc.1.scd
diff options
context:
space:
mode:
authorARaspiK <araspik@protonmail.com>2020-08-18 20:27:23 +0000
committerReto Brunner <reto@labrat.space>2020-08-19 11:38:57 +0200
commitfe1cabb077cf6c6cb3de122b3f5532acbeba8c85 (patch)
tree6f57a28a507c500df82f991cefd67910eca973f0 /doc/aerc.1.scd
parentf4dc7e1f746582d42462ec56347dd354756203b0 (diff)
downloadaerc-fe1cabb077cf6c6cb3de122b3f5532acbeba8c85.tar.gz
Add support for :rmdir
The `:rmdir` command removes the current directory (`-f` is required if
the directory is not empty).

This is not supported on the notmuch backend.

An issue with the maildir backend is that some sync programs (e.g.
offlineimap) may recover the directory after it is deleted.  They need
to specifically be configured to accept deletions, or special commands
need to be executed (e.g. `offlineimap --delete-folder`) to properly
delete folders.

A danger of using this on the IMAP backend is that it is possible for a
new message to be added to the directory and for aerc to not show it
immediately (due to a slow connection) - using `:rmdir` at this moment
(with `-f` if the directory already contains messages) would delete the
directory and the new message that just arrived (and all other
contents).  This is documented in aerc(1) so that users are aware of
possible risks.
Diffstat (limited to 'doc/aerc.1.scd')
-rw-r--r--doc/aerc.1.scd22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index 89189d5..c2f813a 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -214,6 +214,28 @@ message list, the message in the message viewer, etc).
 *mkdir* <name>
 	Creates a new folder for this account and changes to that folder.
 
+	This is not supported on the 'notmuch' backend.
+
+*rmdir* [-f]
+	Removes the current folder.
+
+	By default, it will fail if the directory is non-empty (see *-f*).
+
+	*-f*
+		Remove the directory even if it contains messages.
+
+	This is not supported on the 'notmuch' backend.
+
+	Some programs that sync maildirs may recover deleted directories (e.g.
+	offlineimap).  These can either be specially configured to properly
+	handle directory deletion, or special commands need to be run to delete
+	directories (e.g. 'offlineimap --delete-folder').
+
+	It is possible, with a slow connection and the 'imap' backend, that new
+	messages arrive in the directory before they show up - using 'rmdir' at
+	this moment would delete the directory and such new messages before the
+	user sees them.
+
 *next* <n>[%], *prev* <n>[%]
 	Selects the next (or previous) message in the message list. If specified as
 	a percentage, the percentage is applied to the number of messages shown on