emacs: Document notmuch-show-get-message-properties

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index ec9c52cd94c2eb5d3e54aa367730d0b377f14ba1..63b01e53961faa4620f24a3f748e3c6ffa7267bc 100644 (file)
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -1053,6 +1053,12 @@ All currently available key bindings:
     (put-text-property (point) (+ (point) 1) :notmuch-message-properties props)))
 
 (defun notmuch-show-get-message-properties ()
+  "Return the properties of the current message as a plist.
+
+Some useful entries are:
+:headers - Property list containing the headers :Date, :Subject, :From, etc.
+:body - Body of the message
+:tags - Tags for this message"
   (save-excursion
     (notmuch-show-move-to-message-top)
     (get-text-property (point) :notmuch-message-properties)))