mu4e: update outdated doc for mime-part actions

As noted in #2351.
This commit is contained in:
Dirk-Jan C. Binnema 2022-10-17 07:29:01 +03:00
parent 3c9e93228a
commit 9f096a2ba6
1 changed files with 12 additions and 12 deletions

View File

@ -2677,7 +2677,7 @@ For general information extending @t{mu4e} and writing your own functions, see
* Defining actions::How to create an action * Defining actions::How to create an action
* Headers view actions::Doing things with message headers * Headers view actions::Doing things with message headers
* Message view actions::Doing things with messages * Message view actions::Doing things with messages
* Attachment actions::Doing things with attachments * MIME-part actions::Doing things with MIME-parts such as attachments
* Example actions::Some more examples * Example actions::Some more examples
@end menu @end menu
@ -2711,7 +2711,7 @@ After you have defined your function, you can add it to the list of
actions@footnote{Instead of defining the functions separately, you can actions@footnote{Instead of defining the functions separately, you can
obviously also add a @code{lambda}-function directly to the list; however, obviously also add a @code{lambda}-function directly to the list; however,
separate functions are easier to change}, either @code{mu4e-headers-actions}, separate functions are easier to change}, either @code{mu4e-headers-actions},
@code{mu4e-view-actions} or @code{mu4e-view-attachment-actions}. The @code{mu4e-view-actions} or @code{mu4e-view-mime-part-actions}. The
format@footnote{Note, the format of the actions has changed since version format@footnote{Note, the format of the actions has changed since version
0.9.8.4, and you must change your configuration to use the new format; 0.9.8.4, and you must change your configuration to use the new format;
@t{mu4e} warns you when you are using the old format.} of each action is a @t{mu4e} warns you when you are using the old format.} of each action is a
@ -2767,16 +2767,16 @@ is a list of @code{(:name NAME :email EMAIL)} plists; so this code gets
us the e-mail address of the first in the list. @t{From:}-fields rarely us the e-mail address of the first in the list. @t{From:}-fields rarely
have more that one address. have more that one address.
@node Attachment actions @node MIME-part actions
@section Attachment actions @section MIME-part actions
Finally, let's define an attachment action. As mentioned, attachment-action Finally, let's define a MIME-part action. As mentioned, MIME-part
functions receive @emph{2} arguments, the message and the attachment number to functions receive @emph{2} arguments, the message and the attachment
use. number to use.
The following example action counts the number of lines in an attachment, and The following example action counts the number of lines in an
defines @key{n} as its shortcut key (the @key{n} is prefixed to the attachment, and defines @key{n} as its shortcut key (the @key{n} is
description). prefixed to the description).
@lisp @lisp
(defun count-lines-in-attachment (msg attachnum) (defun count-lines-in-attachment (msg attachnum)
@ -2784,7 +2784,7 @@ description).
(mu4e-view-pipe-attachment msg attachnum "wc -l")) (mu4e-view-pipe-attachment msg attachnum "wc -l"))
;; defining 'n' as the shortcut ;; defining 'n' as the shortcut
(add-to-list 'mu4e-view-attachment-actions (add-to-list 'mu4e-view-mime-part-actions
'("ncount lines" . count-lines-in-attachment) t) '("ncount lines" . count-lines-in-attachment) t)
@end lisp @end lisp
@ -2828,7 +2828,7 @@ see @ref{Headers view actions}
see @ref{Message view actions} see @ref{Message view actions}
@item Add a new kind of mark for use in the headers view @item Add a new kind of mark for use in the headers view
- see @ref{Adding a new kind of mark} - see @ref{Adding a new kind of mark}
@item Apply a function to an attachment --- see @ref{Attachment actions} @item Apply a function to a MIME-part --- see @ref{MIME-part actions}
@item Custom function to mark certain messages --- @item Custom function to mark certain messages ---
see @ref{Custom mark functions} see @ref{Custom mark functions}
@item Using various @emph{mode}-hooks, @code{mu4e-compose-pre-hook} (see @item Using various @emph{mode}-hooks, @code{mu4e-compose-pre-hook} (see