summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorBen Burwell <ben@benburwell.com>2019-07-04 11:01:07 -0400
committerDrew DeVault <sir@cmpwn.com>2019-07-04 11:06:14 -0400
commit030f39043628f01b174ebb11595a4e74da95f0b3 (patch)
tree93a7562a76b664e50ddd4bb3d20a11d191ef4169 /doc
parent1bb1a8015659e0cfde45be9fe9440dbb254680cf (diff)
downloadaerc-030f39043628f01b174ebb11595a4e74da95f0b3.tar.gz
Add unsubscribe command
The unsubscribe command, available when in a message viewer context,
enables users to easily unsubscribe from mailing lists.

When the command is executed, aerc looks for a List-Unsubscribe header
as defined in RFC 2369. If found, aerc will attempt to present the user
with a suitable interface for completing the request. Currently, mailto
and http(s) URLs are supported. In the case of a HTTP(S) URL, aerc will
open the link in a browser. For mailto links, a new composer tab will be
opened with a message filled out according to the URL. The message is
not sent automatically in order to provide the user a chance to review
it first.

Closes #101
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc.1.scd6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/aerc.1.scd b/doc/aerc.1.scd
index 0b86f75..aa2e5ba 100644
--- a/doc/aerc.1.scd
+++ b/doc/aerc.1.scd
@@ -85,6 +85,12 @@ message list, the message in the message viewer, etc).
 *unread*
 	Marks the selected message as unread.
 
+*unsubscribe*
+	Attempt to automatically unsubscribe the user from the mailing list through
+	use of the List-Unsubscribe header. If supported, aerc may open a compose
+	window pre-filled with the unsubscribe information or open the unsubscribe
+	URL in a web browser.
+
 ## MESSAGE LIST COMMANDS
 
 *cf* <folder>