mu4e: update documentation with some examples

This commit is contained in:
djcb
2014-11-22 13:23:01 +02:00
parent 80b4c17edc
commit ddc3297ce9

View File

@ -922,13 +922,26 @@ takes a message-plist as its argument (@ref{Message functions}).
(length (mu4e-message-field msg :cc)))))))) (length (mu4e-message-field msg :cc))))))))
@end lisp @end lisp
You can now add this custom header to your @code{mu4e-headers-fields} just Or, let's get the full mailing-list name:
like the built-in headers. After evaluating, you headers-view should now @lisp
include a new header @t{Recip#} with the number of recipients. (add-to-list 'mu4e-header-info-custom
'(:full-mailing-list .
( :name "Mailing-list" ;; long name, as seen in the message-view
:shortname "ML" ;; short name, as seen in the headers view
:help "Full name for mailing list" ;; tooltip
:function
(lambda (msg)
(or (mu4e-message-field msg :mailing-list) "")))))
@end lisp
Note that this function can be used in both the headers-view and the You can then add the custom header to your @code{mu4e-headers-fields},
message-view; if you need something specific for one of these, you can check just like the built-in headers. After evaluation, you headers-view
for the mode in your function. should include a new header @t{Recip#} with the number of recipients,
and/or @t{ML} with the full mailing-list name.
This function can be used in both the headers-view and the message-view;
if you need something specific for one of these, you can check for the
mode in your function, or create separate functions.
@node HV Actions @node HV Actions
@section Actions @section Actions
@ -1229,7 +1242,7 @@ installing that, you can tell @t{mu4e} to use it with something like:
"html2markdown | grep -v '&nbsp_place_holder;'") "html2markdown | grep -v '&nbsp_place_holder;'")
@end lisp @end lisp
On MacOS, there is a program called @t{textutil} as yet another alternative: OS X, there is a program called @t{textutil} as yet another alternative:
@lisp @lisp
(setq mu4e-html2text-command (setq mu4e-html2text-command
@ -1253,6 +1266,15 @@ this, add the following to your configuration:
(setq mu4e-html2text-command 'mu4e-shr2text) (setq mu4e-html2text-command 'mu4e-shr2text)
@end lisp @end lisp
If you use the @code{mu4e-shr2text}, it might be useful to emulate some
of the @t{shr} key bindings, with something like:
@lisp
(add-hook 'mu4e-view-mode-hook
(lambda()
;; try to emulate some of the eww key-bindings
(local-set-key (kbd "<tab>") 'shr-next-link)
(local-set-key (kbd "<backtab>") 'shr-previous-link)))
@end lisp
@node MSGV Crypto @node MSGV Crypto
@section Crypto @section Crypto
@ -2053,10 +2075,10 @@ than @emph{n} recipients -- we could do this with the following recipe:
(read-number "Match messages with more recipients than: "))) t) (read-number "Match messages with more recipients than: "))) t)
@end lisp @end lisp
After evaluating this expression, you can use it by pressing @key{&} in the After evaluating this expression, you can use it by pressing @key{&} in
headers buffer to select a custom marker function, and then @key{M} to choose the headers buffer to select a custom marker function, and then @key{M}
this particular one (@t{M} because it is the first character of the to choose this particular one (@t{M} because it is the first character
description). of the description).
As you can see, it's not very hard to define simple functions to match As you can see, it's not very hard to define simple functions to match
messages. There are more examples in the defaults for messages. There are more examples in the defaults for