| blob | 86dcae229ee8154978f9d0098ddd3891a06a7106 |
1 ;;; mail-hist.el --- Headers and message body history for outgoing mail.
3 ;; Copyright (C) 1994 Free Software Foundation, Inc.
5 ;; Author: Karl Fogel <kfogel@cs.oberlin.edu>
6 ;; Created: March, 1994
7 ;; Keywords: mail, history
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
26 ;;; Commentary:
28 ;; Thanks to Jim Blandy for mentioning ring.el. It saved a lot of
29 ;; time.
30 ;;
31 ;; To use this package, put it in a directory in your load-path, and
32 ;; put this in your .emacs file:
33 ;;
34 ;; (load "mail-hist" nil t)
35 ;;
36 ;; Or you could do it with autoloads and hooks in your .emacs:
37 ;;
38 ;; (add-hook 'mail-mode-hook 'mail-hist-define-keys)
39 ;; (add-hook 'mail-send-hook 'mail-hist-put-headers-into-history)
40 ;; (add-hook 'vm-mail-mode-hook 'mail-hist-define-keys) ;or rmail, etc
41 ;; (autoload 'mail-hist-define-keys "mail-hist")
42 ;; (autoload 'mail-hist-put-headers-into-history "mail-hist")
43 ;;
44 ;; Once it's installed, use M-p and M-n from mail headers to recover
45 ;; previous/next contents in the history for that header, or, in the
46 ;; body of the message, to recover previous/next text of the message.
47 ;; This only applies to outgoing mail -- mail-hist ignores received
48 ;; messages.
49 ;;
50 ;; Although repeated history requests do clear out the text from the
51 ;; previous request, an isolated request just inserts its text at
52 ;; point, so that you can mix the histories of different messages
53 ;; easily. This might be confusing at times, but there should be no
54 ;; problems that undo can't handle.
55 \f
56 ;;; Code:
60 "Headers and message body history for outgoing mail."
64 ;;;###autoload
66 "Define keys for accessing mail header history. For use in hooks."
70 ;;;###autoload
76 "Alist of form (header-name . history-ring).
77 Used for knowing which history list to look in when the user asks for
81 "*The maximum number of elements in a mail field's history.
82 Oldest elements are dumped first."
86 ;;;###autoload
88 "*Non-nil means keep a history for headers and text of outgoing mail."
92 ;; For handling repeated history requests
96 ;; (start . end) A pair indicating the buffer positions delimiting the
97 ;; last inserted history, so it can be replaced by a new input if the
98 ;; command is repeated.
102 \f
104 "Get name of mail header point is currently in, without the colon.
105 Returns nil if not in a header, implying that point is in the body of
106 the message."
110 nil t))
111 nil ; then we are in the body of the message
117 nil t)))
123 name-start
124 name-end
128 "Move forward COUNT headers (backward if COUNT is negative).
129 If last/first header is encountered first, stop there and returns
130 nil.
132 Places point on the first non-whitespace on the line following the
133 colon after the header name, or on the second space following that if
134 the header is empty."
138 nil t))))
140 boundary
149 unstopped
152 ;; because the current header will match too.
154 ;; count is negative
157 unstopped
160 ;; we end up behind the header, so must move to the front
162 ;; Now we are right after the colon
164 ;; return nil if didn't go as far as asked, otherwise point
165 unstopped))))
168 "Move to the start of the current header.
169 The start of the current header is defined as one space after the
170 colon, or just after the colon if it is not followed by whitespace."
171 ;; this is slick as all heck:
178 "Get the contents of the mail header in which point is located."
189 "Get HEADER's history ring, or nil if none.
190 HEADER is a string without the colon."
195 "*Don't store any header or body with more than this many characters.
196 If the value is nil, that means no limit on text size."
201 "Return t if TEXT does not exceed mail-hist's size limit.
202 The variable `mail-hist-text-size-limit' defines this limit."
207 "Add the contents of HEADER to the header history ring.
208 Optional argument CONTENTS is a string which will be the contents
209 \(instead of whatever's found in the header)."
215 ;; If the ring doesn't exist, we'll have to make it and add it
216 ;; to the mail-header-ring-alist:
223 ;;;###autoload
225 "Put headers and contents of this message into mail header history.
226 Each header has its own independent history, as does the body of the
227 message.
229 This function normally would be called when the message is sent."
231 mail-hist-keep-history
242 nil)
246 \f
248 "Insert the previous contents of this mail header or message body.
249 Moves back through the history of sent mail messages. Each header has
250 its own independent history, as does the body of the message.
252 The history only contains the contents of outgoing messages, not
253 received mail."
278 "Insert next contents of this mail header or message body.
279 Moves back through the history of sent mail messages. Each header has
280 its own independent history, as does the body of the message.
282 Although you can do so, it does not make much sense to call this
283 without having called `mail-hist-previous-header' first
286 The history only contains the contents of outgoing messages, not
287 received mail."
310 \f
313 ;; mail-hist.el ends here