[PATCH v2 1/3] emacs: Document notmuch-show-get-message-properties

Daniel Schoepe daniel.schoepe at googlemail.com
Fri Jul 8 11:46:55 PDT 2011


---
 emacs/notmuch-show.el |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index f96743b..262addb 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -999,6 +999,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)))
-- 
1.7.5.4



More information about the notmuch mailing list