mh-e.el 103 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; mh-e.el --- GNU Emacs interface to the MH mail system

Bill Wohler's avatar
Bill Wohler committed
3
;; Copyright (C) 1985, 86, 87, 88, 90, 92, 93, 94, 95, 97, 1999,
Bill Wohler's avatar
Bill Wohler committed
4
;;  2000, 01, 02, 03, 2004 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

Bill Wohler's avatar
Bill Wohler committed
6
;; Author: Bill Wohler <wohler@newt.com>
Gerd Moellmann's avatar
Gerd Moellmann committed
7
;; Maintainer: Bill Wohler <wohler@newt.com>
Bill Wohler's avatar
Bill Wohler committed
8
;; Version: 7.4.4
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10
;; Keywords: mail

11
;; This file is part of GNU Emacs.
Karl Heuer's avatar
Karl Heuer committed
12 13

;; GNU Emacs is free software; you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
14 15 16 17
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

Karl Heuer's avatar
Karl Heuer committed
18
;; GNU Emacs is distributed in the hope that it will be useful,
Richard M. Stallman's avatar
Richard M. Stallman committed
19 20 21 22 23
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
24 25 26
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
27 28 29

;;; Commentary:

Bill Wohler's avatar
Bill Wohler committed
30 31 32 33
;; How to Use:
;;   M-x mh-rmail to read mail.  Type C-h m there for a list of commands.
;;   C-u M-x mh-rmail to visit any folder.
;;   M-x mh-smail to send mail.  From within the mail reader, "m" works, too.
Erik Naggum's avatar
Erik Naggum committed
34

Bill Wohler's avatar
Bill Wohler committed
35 36 37 38
;; Your .emacs might benefit from these bindings:
;;   (global-set-key "\C-cr" 'mh-rmail)
;;   (global-set-key "\C-xm" 'mh-smail)
;;   (global-set-key "\C-x4m" 'mh-smail-other-window)
Erik Naggum's avatar
Erik Naggum committed
39

Bill Wohler's avatar
Bill Wohler committed
40
;; MH (Message Handler) is a powerful mail reader.
Erik Naggum's avatar
Erik Naggum committed
41

Bill Wohler's avatar
Bill Wohler committed
42 43
;; The MH newsgroup is comp.mail.mh; the mailing list is mh-users@ics.uci.edu
;; (send to mh-users-request to be added). See the monthly Frequently Asked
Bill Wohler's avatar
Bill Wohler committed
44
;; Questions posting there for information on getting MH and MH-E:
Bill Wohler's avatar
Bill Wohler committed
45
;;   http://www.faqs.org/faqs/mail/mh-faq/part1/preamble.html
Erik Naggum's avatar
Erik Naggum committed
46

Bill Wohler's avatar
Bill Wohler committed
47
;; N.B. MH must have been compiled with the MHE compiler flag or several
Bill Wohler's avatar
Bill Wohler committed
48
;; features necessary for MH-E will be missing from MH commands, specifically
Erik Naggum's avatar
Erik Naggum committed
49 50
;; the -build switch to repl and forw.

Bill Wohler's avatar
Bill Wohler committed
51
;; MH-E is an Emacs interface to the MH mail system.
Bill Wohler's avatar
Bill Wohler committed
52

Bill Wohler's avatar
Bill Wohler committed
53
;; MH-E is supported in GNU Emacs 20 and 21, with MH 6.8.4 and nmh 1.0.4.
Bill Wohler's avatar
Bill Wohler committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

;; Mailing Lists:
;;   mh-e-users@lists.sourceforge.net
;;   mh-e-announce@lists.sourceforge.net
;;   mh-e-devel@lists.sourceforge.net
;;
;;   Subscribe by sending a "subscribe" message to
;;   <list>-request@lists.sourceforge.net, or by using the web interface at
;;   https://sourceforge.net/mail/?group_id=13357

;; Bug Reports:
;;   https://sourceforge.net/tracker/?group_id=13357&atid=113357
;;   Include the output of M-x mh-version in any bug report.

;; Feature Requests:
;;   https://sourceforge.net/tracker/?atid=363357&group_id=13357&func=browse

;; Support:
;;   https://sourceforge.net/tracker/?group_id=13357&atid=213357
Erik Naggum's avatar
Erik Naggum committed
73

Erik Naggum's avatar
Erik Naggum committed
74
;;; Change Log:
Erik Naggum's avatar
Erik Naggum committed
75 76 77 78

;; Original version for Gosling emacs by Brian Reid, Stanford, 1982.
;; Modified by James Larus, BBN, July 1984 and UCB, 1984 & 1985.
;; Rewritten for GNU Emacs, James Larus 1985.  larus@ginger.berkeley.edu
Bill Wohler's avatar
Bill Wohler committed
79 80 81 82
;; Modified by Stephen Gildea 1988.  gildea@lcs.mit.edu
;; Maintenance picked up by Bill Wohler <wohler@newt.com> and the
;; SourceForge Crew <http://mh-e.sourceforge.net/>. 2001.

Richard M. Stallman's avatar
Richard M. Stallman committed
83 84
;;; Code:

Bill Wohler's avatar
Bill Wohler committed
85 86 87
(provide 'mh-e)
(require 'mh-utils)
(mh-require-cl)
Bill Wohler's avatar
Bill Wohler committed
88 89 90 91 92 93 94 95

(defvar recursive-load-depth-limit)
(eval-when (compile load eval)
  (if (and (boundp 'recursive-load-depth-limit)
           (integerp recursive-load-depth-limit)
           (> 50 recursive-load-depth-limit))
      (setq recursive-load-depth-limit 50)))

Bill Wohler's avatar
Bill Wohler committed
96
(require 'mh-inc)
Bill Wohler's avatar
Bill Wohler committed
97 98 99
(require 'gnus-util)
(require 'easymenu)

Bill Wohler's avatar
Bill Wohler committed
100 101 102
;; Shush the byte-compiler
(defvar font-lock-auto-fontify)
(defvar font-lock-defaults)
Bill Wohler's avatar
Bill Wohler committed
103

Bill Wohler's avatar
Bill Wohler committed
104
(defconst mh-version "7.4.4" "Version number of MH-E.")
Bill Wohler's avatar
Bill Wohler committed
105 106

;;; Autoloads
Bill Wohler's avatar
Bill Wohler committed
107
(autoload 'Info-goto-node "info")
Richard M. Stallman's avatar
Richard M. Stallman committed
108 109


Bill Wohler's avatar
Bill Wohler committed
110

Karl Heuer's avatar
Karl Heuer committed
111 112 113 114 115 116 117 118
(defvar mh-note-deleted "D"
  "String whose first character is used to notate deleted messages.")

(defvar mh-note-refiled "^"
  "String whose first character is used to notate refiled messages.")

(defvar mh-note-cur "+"
  "String whose first character is used to notate the current message.")
Richard M. Stallman's avatar
Richard M. Stallman committed
119 120 121

(defvar mh-partial-folder-mode-line-annotation "select"
  "Annotation when displaying part of a folder.
Bill Wohler's avatar
Bill Wohler committed
122
The string is displayed after the folder's name.  nil for no annotation.")
Bill Wohler's avatar
Bill Wohler committed
123

Bill Wohler's avatar
Bill Wohler committed
124
;;; Parameterize MH-E to work with different scan formats.  The defaults work
Bill Wohler's avatar
Bill Wohler committed
125 126 127 128 129 130
;;; with the standard MH scan listings, in which the first 4 characters on
;;; the line are the message number, followed by two places for notations.

;; The following scan formats are passed to the scan program if the
;; setting of `mh-scan-format-file' above is nil.  They are identical
;; except the later one makes use of the nmh `decode' function to
Bill Wohler's avatar
Bill Wohler committed
131 132
;; decode RFC 2047 encodings. If you just want to change the width of
;; the msg number, use the `mh-set-cmd-note' function.
Bill Wohler's avatar
Bill Wohler committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149

(defvar mh-scan-format-mh
  (concat
   "%4(msg)"
   "%<(cur)+%| %>"
   "%<{replied}-"
   "%?(nonnull(comp{to}))%<(mymbox{to})t%>"
   "%?(nonnull(comp{cc}))%<(mymbox{cc})c%>"
   "%?(nonnull(comp{bcc}))%<(mymbox{bcc})b%>"
   "%?(nonnull(comp{newsgroups}))n%>"
   "%<(zero) %>"
   "%02(mon{date})/%02(mday{date})%<{date} %|*%>"
   "%<(mymbox{from})%<{to}To:%14(friendly{to})%>%>"
   "%<(zero)%17(friendly{from})%>  "
   "%{subject}%<{body}<<%{body}%>")
  "*Scan format string for MH, provided to the scan program via the -format arg.
This format is identical to the default except that additional hints for
Bill Wohler's avatar
Bill Wohler committed
150 151
fontification have been added to the fifth column (remember that in Emacs, the
first column is 0).
Bill Wohler's avatar
Bill Wohler committed
152

Bill Wohler's avatar
Bill Wohler committed
153
The values of the fifth column, in priority order, are: `-' if the
Bill Wohler's avatar
Bill Wohler committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
message has been replied to, t if an address on the To: line matches
one of the mailboxes of the current user, `c' if the Cc: line matches,
`b' if the Bcc: line matches, and `n' if a non-empty Newsgroups: header
is present.")

(defvar mh-scan-format-nmh
  (concat
   "%4(msg)"
   "%<(cur)+%| %>"
   "%<{replied}-"
   "%?(nonnull(comp{to}))%<(mymbox{to})t%>"
   "%?(nonnull(comp{cc}))%<(mymbox{cc})c%>"
   "%?(nonnull(comp{bcc}))%<(mymbox{bcc})b%>"
   "%?(nonnull(comp{newsgroups}))n%>"
   "%<(zero) %>"
   "%02(mon{date})/%02(mday{date})%<{date} %|*%>"
   "%<(mymbox{from})%<{to}To:%14(decode(friendly{to}))%>%>"
   "%<(zero)%17(decode(friendly{from}))%>  "
   "%(decode{subject})%<{body}<<%{body}%>")
Bill Wohler's avatar
Bill Wohler committed
173 174
  "*Scan format string for nmh.
This string is passed to the scan program via the -format arg.
Bill Wohler's avatar
Bill Wohler committed
175
This format is identical to the default except that additional hints for
Bill Wohler's avatar
Bill Wohler committed
176 177
fontification have been added to the fifth column (remember that in Emacs, the
first column is 0).
Bill Wohler's avatar
Bill Wohler committed
178

Bill Wohler's avatar
Bill Wohler committed
179
The values of the fifth column, in priority order, are: `-' if the
Bill Wohler's avatar
Bill Wohler committed
180 181 182 183 184
message has been replied to, t if an address on the To: line matches
one of the mailboxes of the current user, `c' if the Cc: line matches,
`b' if the Bcc: line matches, and `n' if a non-empty Newsgroups: header
is present.")

Bill Wohler's avatar
Bill Wohler committed
185
(defvar mh-scan-good-msg-regexp  "^\\( *[0-9]+\\)[^D^0-9]"
Bill Wohler's avatar
Bill Wohler committed
186 187 188 189
  "Regexp specifying the scan lines that are 'good' messages.
The default `mh-folder-font-lock-keywords' expects this expression to contain
at least one parenthesized expression which matches the message number.")

Bill Wohler's avatar
Bill Wohler committed
190
(defvar mh-scan-deleted-msg-regexp "^\\( *[0-9]+\\)D"
Bill Wohler's avatar
Bill Wohler committed
191 192 193 194
  "Regexp matching scan lines of deleted messages.
The default `mh-folder-font-lock-keywords' expects this expression to contain
at least one parenthesized expression which matches the message number.")

Bill Wohler's avatar
Bill Wohler committed
195
(defvar mh-scan-refiled-msg-regexp  "^\\( *[0-9]+\\)\\^"
Bill Wohler's avatar
Bill Wohler committed
196 197 198 199 200 201 202
  "Regexp matching scan lines of refiled messages.
The default `mh-folder-font-lock-keywords' expects this expression to contain
at least one parenthesized expression which matches the message number.")

(defvar mh-scan-valid-regexp "^ *[0-9]"
  "Regexp matching scan lines for messages (not error messages).")

Bill Wohler's avatar
Bill Wohler committed
203
(defvar mh-scan-cur-msg-number-regexp "^\\( *[0-9]+\\+\\).*"
Bill Wohler's avatar
Bill Wohler committed
204 205 206 207 208
  "Regexp matching scan line for the current message.
The default `mh-folder-font-lock-keywords' expects this expression to contain
at least one parenthesized expression which matches the message number.
Don't disable this regexp as it's needed by non fontifying functions.")

Bill Wohler's avatar
Bill Wohler committed
209
(defvar mh-scan-cur-msg-regexp "^\\( *[0-9]+\\+DISABLED.*\\)"
Bill Wohler's avatar
Bill Wohler committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
  "Regexp matching scan line for the current message.
The default `mh-folder-font-lock-keywords' expects this expression to contain
at least one parenthesized expression which matches the whole line.
To enable this feature, remove the string DISABLED from the regexp.")

(defvar mh-scan-date-regexp "\\([0-9][0-9]/[0-9][0-9]\\)"
  "Regexp matching a valid date in scan lines.
The default `mh-folder-font-lock-keywords' expects this expression to contain
only one parenthesized expression which matches the date field
\(see `mh-scan-format-regexp').")

(defvar mh-scan-rcpt-regexp  "\\(To:\\)\\(..............\\)"
  "Regexp specifying the recipient in scan lines for messages we sent.
The default `mh-folder-font-lock-keywords' expects this expression to contain
two parenthesized expressions.  The first is expected to match the To:
that the default scan format file generates.  The second is expected to match
the recipient's name.")

(defvar mh-scan-body-regexp "\\(<<\\([^\n]+\\)?\\)"
  "Regexp matching the message body beginning displayed in scan lines.
The default `mh-folder-font-lock-keywords' expects this expression to contain
at least one parenthesized expression which matches the body text.")

(defvar mh-scan-subject-regexp
Bill Wohler's avatar
Bill Wohler committed
234
  ;;"^ *[0-9]+........[ ]*...................\\([Rr][Ee]:\\s-*\\)*\\([^<\n]*\\)"
Bill Wohler's avatar
Bill Wohler committed
235
  "^ *[0-9]+........[ ]*...................\\([Rr][Ee]\\(\\[[0-9]+\\]\\)?:\\s-*\\)*\\([^<\n]*\\)"
Bill Wohler's avatar
Bill Wohler committed
236 237
  "*Regexp matching the subject string in MH folder mode.
The default `mh-folder-font-lock-keywords' expects this expression to contain
Bill Wohler's avatar
Bill Wohler committed
238 239 240
at least tree parenthesized expressions. The first is expected to match the Re:
string, if any. The second matches an optional bracketed number after Re,
such as in Re[2]: and the third is expected to match the subject line itself.")
Bill Wohler's avatar
Bill Wohler committed
241 242

(defvar mh-scan-format-regexp
Bill Wohler's avatar
Bill Wohler committed
243 244 245 246
  (concat "\\([bct]\\)" mh-scan-date-regexp " *\\(..................\\)")
  "Regexp matching the output of scan.
The default value is based upon the default values of either
`mh-scan-format-mh' or `mh-scan-format-nmh'.
Bill Wohler's avatar
Bill Wohler committed
247 248 249 250 251
The default `mh-folder-font-lock-keywords' expects this expression to contain
at least three parenthesized expressions. The first should match the
fontification hint, the second is found in `mh-scan-date-regexp', and the
third should match the user name.")

Bill Wohler's avatar
Bill Wohler committed
252 253


Bill Wohler's avatar
Bill Wohler committed
254 255
(defvar mh-folder-font-lock-keywords
  (list
Bill Wohler's avatar
Bill Wohler committed
256 257 258
   ;; Folders when displaying index buffer
   (list "^\\+.*"
         '(0 mh-index-folder-face))
Bill Wohler's avatar
Bill Wohler committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
   ;; Marked for deletion
   (list (concat mh-scan-deleted-msg-regexp ".*")
         '(0 mh-folder-deleted-face))
   ;; Marked for refile
   (list (concat mh-scan-refiled-msg-regexp ".*")
         '(0 mh-folder-refiled-face))
   ;;after subj
   (list mh-scan-body-regexp '(1 mh-folder-body-face nil t))
   '(mh-folder-font-lock-subject
     (1 mh-folder-followup-face append t)
     (2 mh-folder-subject-face append t))
   ;;current msg
   (list mh-scan-cur-msg-number-regexp
         '(1 mh-folder-cur-msg-number-face))
   (list mh-scan-good-msg-regexp
Bill Wohler's avatar
Bill Wohler committed
274 275
         '(1 mh-folder-msg-number-face)) ;; Msg number
   (list mh-scan-date-regexp '(1 mh-folder-date-face)) ;; Date
Bill Wohler's avatar
Bill Wohler committed
276
   (list mh-scan-rcpt-regexp
Bill Wohler's avatar
Bill Wohler committed
277 278
         '(1 mh-folder-to-face) ;; To:
         '(2 mh-folder-address-face)) ;; address
Bill Wohler's avatar
Bill Wohler committed
279 280 281 282 283 284
   ;; scan font-lock name
   (list mh-scan-format-regexp
         '(1 mh-folder-date-face)
         '(3 mh-folder-scan-format-face))
   ;; Current message line
   (list mh-scan-cur-msg-regexp
Bill Wohler's avatar
Bill Wohler committed
285
         '(1 mh-folder-cur-msg-face prepend t)))
Bill Wohler's avatar
Bill Wohler committed
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  "Regexp keywords used to fontify the MH-Folder buffer.")

(defvar mh-scan-cmd-note-width 1
  "Number of columns consumed by the cmd-note field in `mh-scan-format'.
This column will have one of the values: ` ', `D', `^', `+' and where
` ' is the default value,
`D' is the `mh-note-deleted' character,
`^' is the `mh-note-refiled' character, and
`+' is the `mh-note-cur' character.")

(defvar mh-scan-destination-width 1
  "Number of columns consumed by the destination field in `mh-scan-format'.
This column will have one of ' ', '%', '-', 't', 'c', 'b', or `n' in it.
A ' ' blank space is the default character.
A '%' indicates that the message in in a named MH sequence.
A '-' indicates that the message has been annotated with a replied field.
A 't' indicates that the message contains mymbox in the To: field.
A 'c' indicates that the message contains mymbox in the Cc: field.
A 'b' indicates that the message contains mymbox in the Bcc: field.
A 'n' indicates that the message contains a Newsgroups: field.")

(defvar mh-scan-date-width 5
  "Number of columns consumed by the date field in `mh-scan-format'.
This column will typically be of the form mm/dd.")

(defvar mh-scan-date-flag-width 1
  "Number of columns consumed to flag (in)valid dates in `mh-scan-format'.
This column will have ` ' for valid and `*' for invalid or missing dates.")

(defvar mh-scan-from-mbox-width 17
  "Number of columns consumed with the \"From:\" line in `mh-scan-format'.
This column will have a friendly name or e-mail address of the
originator, or a \"To: address\" for outgoing e-mail messages.")

(defvar mh-scan-from-mbox-sep-width 2
  "Number of columns consumed by whitespace after from-mbox in `mh-scan-format'.
This column will only ever have spaces in it.")

(defvar mh-scan-field-from-start-offset
Bill Wohler's avatar
Bill Wohler committed
325 326 327 328 329
  (+ mh-scan-cmd-note-width
     mh-scan-destination-width
     mh-scan-date-width
     mh-scan-date-flag-width)
  "The offset from the `mh-cmd-note' to find the start of \"From:\" address.")
Bill Wohler's avatar
Bill Wohler committed
330 331

(defvar mh-scan-field-from-end-offset
Bill Wohler's avatar
Bill Wohler committed
332 333
  (+ mh-scan-field-from-start-offset mh-scan-from-mbox-width)
  "The offset from the `mh-cmd-note' to find the end of \"From:\" address.")
Bill Wohler's avatar
Bill Wohler committed
334 335 336 337 338 339 340 341 342

(defvar mh-scan-field-subject-start-offset
  (+ mh-scan-cmd-note-width
     mh-scan-destination-width
     mh-scan-date-width
     mh-scan-date-flag-width
     mh-scan-from-mbox-width
     mh-scan-from-mbox-sep-width)
  "The offset from the `mh-cmd-note' to find the start of the subject.")
Bill Wohler's avatar
Bill Wohler committed
343 344

(defun mh-folder-font-lock-subject (limit)
Bill Wohler's avatar
Bill Wohler committed
345
  "Return MH-E scan subject strings to font-lock between point and LIMIT."
Bill Wohler's avatar
Bill Wohler committed
346 347 348
  (if (not (re-search-forward mh-scan-subject-regexp limit t))
      nil
    (if (match-beginning 1)
Bill Wohler's avatar
Bill Wohler committed
349 350 351 352
        (set-match-data (list (match-beginning 1) (match-end 3)
                              (match-beginning 1) (match-end 3) nil nil))
      (set-match-data (list (match-beginning 3) (match-end 3)
                            nil nil (match-beginning 3) (match-end 3))))
Bill Wohler's avatar
Bill Wohler committed
353 354
    t))

Bill Wohler's avatar
Bill Wohler committed
355 356 357 358


;; Fontifify unseen mesages in bold.

Bill Wohler's avatar
Bill Wohler committed
359 360 361 362 363 364 365 366 367
(defvar mh-folder-unseen-seq-name nil
  "Name of unseen sequence.
The default for this is provided by the function `mh-folder-unseen-seq-name'
On nmh systems.")

(defun mh-folder-unseen-seq-name ()
  "Provide name of unseen sequence from mhparam."
  (or mh-progs (mh-find-path))
  (save-excursion
Bill Wohler's avatar
Bill Wohler committed
368 369
    (let ((unseen-seq-name "unseen"))
      (with-temp-buffer
Bill Wohler's avatar
Bill Wohler committed
370 371 372 373 374 375 376
        (unwind-protect
            (progn
              (call-process (expand-file-name "mhparam" mh-progs)
                            nil '(t t) nil "-component" "Unseen-Sequence")
              (goto-char (point-min))
              (if (re-search-forward "Unseen-Sequence: \\(.*\\)$" nil t)
                  (setq unseen-seq-name (match-string 1))))))
Bill Wohler's avatar
Bill Wohler committed
377 378 379 380 381 382 383 384 385 386 387 388
      unseen-seq-name)))

(defun mh-folder-unseen-seq-list ()
  "Return a list of unseen message numbers for current folder."
  (if (not mh-folder-unseen-seq-name)
      (setq mh-folder-unseen-seq-name (mh-folder-unseen-seq-name)))
  (cond
   ((not mh-folder-unseen-seq-name)
    nil)
   (t
    (let ((folder mh-current-folder))
      (save-excursion
Bill Wohler's avatar
Bill Wohler committed
389 390 391 392
        (with-temp-buffer
          (unwind-protect
              (progn
                (call-process (expand-file-name "mark" mh-progs)
Bill Wohler's avatar
Bill Wohler committed
393
                              nil '(t t) nil
Bill Wohler's avatar
Bill Wohler committed
394
                              folder "-seq" mh-folder-unseen-seq-name
Bill Wohler's avatar
Bill Wohler committed
395 396 397
                              "-list")
                (goto-char (point-min))
                (sort (mh-read-msg-list) '<)))))))))
Bill Wohler's avatar
Bill Wohler committed
398

Bill Wohler's avatar
Bill Wohler committed
399 400 401 402 403 404 405 406 407 408 409
(defmacro mh-generate-sequence-font-lock (seq prefix face)
  "Generate the appropriate code to fontify messages in SEQ.
PREFIX is used to generate unique names for the variables and functions
defined by the macro. So a different prefix should be provided for every
invocation.
FACE is the font-lock face used to display the matching scan lines."
  (let ((cache (intern (format "mh-folder-%s-seq-cache" prefix)))
        (func (intern (format "mh-folder-font-lock-%s" prefix))))
    `(progn
       (defvar ,cache nil
         "Internal cache variable used for font-lock in MH-E.
Bill Wohler's avatar
Bill Wohler committed
410 411
Should only be non-nil through font-lock stepping, and nil once font-lock
is done highlighting.")
Bill Wohler's avatar
Bill Wohler committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
       (make-variable-buffer-local ',cache)

       (defun ,func (limit)
         "Return unseen message lines to font-lock between point and LIMIT."
         (if (not ,cache) (setq ,cache (mh-seq-msgs (mh-find-seq ,seq))))
         (let ((cur-msg (mh-get-msg-num nil)))
           (cond ((not ,cache)
                  nil)
                 ((>= (point) limit)              ;Presumably at end of buffer
                  (setq ,cache nil)
                  nil)
                 ((member cur-msg ,cache)
                  (let ((bpoint (progn (beginning-of-line)(point)))
                        (epoint (progn (forward-line 1)(point))))
                    (if (<= limit (point)) (setq  ,cache nil))
                    (set-match-data (list bpoint epoint bpoint epoint))
                    t))
                 (t
                  ;; move forward one line at a time, checking each message
                  (while (and (= 0 (forward-line 1))
                              (> limit (point))
                              (not (member (mh-get-msg-num nil) ,cache))))
                  ;; Examine how we must have exited the loop...
                  (let ((cur-msg (mh-get-msg-num nil)))
                    (cond ((or (<= limit (point))
                               (not (member cur-msg ,cache)))
                           (setq ,cache nil)
                           nil)
                          ((member cur-msg ,cache)
                           (let ((bpoint (progn (beginning-of-line) (point)))
                                 (epoint (progn (forward-line 1) (point))))
                             (if (<= limit (point)) (setq ,cache nil))
                             (set-match-data
                              (list bpoint epoint bpoint epoint))
                             t))))))))

       (setq mh-folder-font-lock-keywords
             (append mh-folder-font-lock-keywords
                     (list (list ',func (list 1 '',face 'prepend t))))))))

(mh-generate-sequence-font-lock mh-unseen-seq unseen bold)
(mh-generate-sequence-font-lock mh-tick-seq tick mh-folder-tick-face)
Bill Wohler's avatar
Bill Wohler committed
454 455


Richard M. Stallman's avatar
Richard M. Stallman committed
456 457 458

;;; Internal variables:

Bill Wohler's avatar
Bill Wohler committed
459 460
(defvar mh-last-destination nil)        ;Destination of last refile or write
                                        ;command.
Bill Wohler's avatar
Bill Wohler committed
461 462
(defvar mh-last-destination-folder nil) ;Destination of last refile command.
(defvar mh-last-destination-write nil)  ;Destination of last write command.
Richard M. Stallman's avatar
Richard M. Stallman committed
463 464 465 466

(defvar mh-folder-mode-map (make-keymap)
  "Keymap for MH folders.")

Bill Wohler's avatar
Bill Wohler committed
467 468
(defvar mh-arrow-marker nil)            ;Marker for arrow display in fringe.

Bill Wohler's avatar
Bill Wohler committed
469
(defvar mh-delete-list nil)             ;List of msg numbers to delete.
Richard M. Stallman's avatar
Richard M. Stallman committed
470

Bill Wohler's avatar
Bill Wohler committed
471
(defvar mh-refile-list nil)             ;List of folder names in mh-seq-list.
Richard M. Stallman's avatar
Richard M. Stallman committed
472

Bill Wohler's avatar
Bill Wohler committed
473
(defvar mh-next-direction 'forward)     ;Direction to move to next message.
Richard M. Stallman's avatar
Richard M. Stallman committed
474

Bill Wohler's avatar
Bill Wohler committed
475 476
(defvar mh-view-ops ())                 ;Stack of ops that change the folder
                                        ;view (such as narrowing or threading).
Bill Wohler's avatar
Bill Wohler committed
477
(defvar mh-folder-view-stack ())        ;Stack of previous folder views.
Richard M. Stallman's avatar
Richard M. Stallman committed
478

Bill Wohler's avatar
Bill Wohler committed
479 480 481 482
(defvar mh-index-data nil)              ;Info about index search results
(defvar mh-index-previous-search nil)
(defvar mh-index-msg-checksum-map nil)
(defvar mh-index-checksum-origin-map nil)
Bill Wohler's avatar
Bill Wohler committed
483
(defvar mh-index-sequence-search-flag nil)
Bill Wohler's avatar
Bill Wohler committed
484 485

(defvar mh-first-msg-num nil)           ;Number of first msg in buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
486

Bill Wohler's avatar
Bill Wohler committed
487
(defvar mh-last-msg-num nil)            ;Number of last msg in buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
488

Bill Wohler's avatar
Bill Wohler committed
489
(defvar mh-mode-line-annotation nil)    ;Message range displayed in buffer.
Richard M. Stallman's avatar
Richard M. Stallman committed
490

Bill Wohler's avatar
Bill Wohler committed
491 492 493 494
(defvar mh-sequence-notation-history nil)
                                        ;Rememeber original notation that
                                        ;is overwritten by `mh-note-seq'.

Richard M. Stallman's avatar
Richard M. Stallman committed
495 496
;;; Macros and generic functions:

Bill Wohler's avatar
Bill Wohler committed
497 498
(defun mh-mapc (function list)
  "Apply FUNCTION to each element of LIST for side effects only."
Richard M. Stallman's avatar
Richard M. Stallman committed
499
  (while list
Bill Wohler's avatar
Bill Wohler committed
500
    (funcall function (car list))
Richard M. Stallman's avatar
Richard M. Stallman committed
501 502
    (setq list (cdr list))))

Bill Wohler's avatar
Bill Wohler committed
503
(defun mh-scan-format ()
Bill Wohler's avatar
Bill Wohler committed
504
  "Return the output format argument for the scan program."
Bill Wohler's avatar
Bill Wohler committed
505
  (if (equal mh-scan-format-file t)
Bill Wohler's avatar
Bill Wohler committed
506
      (list "-format" (if mh-nmh-flag
Bill Wohler's avatar
Bill Wohler committed
507 508 509 510
                          (list (mh-update-scan-format
                                 mh-scan-format-nmh mh-cmd-note))
                        (list (mh-update-scan-format
                               mh-scan-format-mh mh-cmd-note))))
Bill Wohler's avatar
Bill Wohler committed
511
    (if (not (equal mh-scan-format-file nil))
Bill Wohler's avatar
Bill Wohler committed
512
        (list "-form" mh-scan-format-file))))
Bill Wohler's avatar
Bill Wohler committed
513

Richard M. Stallman's avatar
Richard M. Stallman committed
514 515 516 517 518 519


;;; Entry points:

;;;###autoload
(defun mh-rmail (&optional arg)
Bill Wohler's avatar
Bill Wohler committed
520
  "Inc(orporate) new mail with MH.
Bill Wohler's avatar
Bill Wohler committed
521
Scan an MH folder if ARG is non-nil. This function is an entry point to MH-E,
Bill Wohler's avatar
Bill Wohler committed
522
the Emacs front end to the MH mail system."
Richard M. Stallman's avatar
Richard M. Stallman committed
523 524 525 526
  (interactive "P")
  (mh-find-path)
  (if arg
      (call-interactively 'mh-visit-folder)
Bill Wohler's avatar
Bill Wohler committed
527 528
    (unless (get-buffer mh-inbox)
      (mh-visit-folder mh-inbox (symbol-name mh-unseen-seq)))
Bill Wohler's avatar
Bill Wohler committed
529
    (mh-inc-folder)))
Richard M. Stallman's avatar
Richard M. Stallman committed
530

Bill Wohler's avatar
Bill Wohler committed
531 532 533
;;;###autoload
(defun mh-nmail (&optional arg)
  "Check for new mail in inbox folder.
Bill Wohler's avatar
Bill Wohler committed
534
Scan an MH folder if ARG is non-nil. This function is an entry point to MH-E,
Bill Wohler's avatar
Bill Wohler committed
535 536
the Emacs front end to the MH mail system."
  (interactive "P")
Bill Wohler's avatar
Bill Wohler committed
537
  (mh-find-path)                        ; init mh-inbox
Bill Wohler's avatar
Bill Wohler committed
538 539 540
  (if arg
      (call-interactively 'mh-visit-folder)
    (mh-visit-folder mh-inbox)))
Richard M. Stallman's avatar
Richard M. Stallman committed
541 542 543



Bill Wohler's avatar
Bill Wohler committed
544
;;; User executable MH-E commands:
Richard M. Stallman's avatar
Richard M. Stallman committed
545

Bill Wohler's avatar
Bill Wohler committed
546 547
(defun mh-delete-msg (range)
  "Mark the specified RANGE for subsequent deletion and move to the next.
Bill Wohler's avatar
Bill Wohler committed
548
Default is the displayed message.
Bill Wohler's avatar
Bill Wohler committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562

Check the documentation of `mh-interactive-range' to see how RANGE is read in
interactive use."
  (interactive (list (mh-interactive-range "Delete")))
  (mh-delete-msg-no-motion range)
  (if (looking-at mh-scan-deleted-msg-regexp) (mh-next-msg)))

(defun mh-delete-msg-no-motion (range)
  "Mark the specified RANGE for subsequent deletion.

Check the documentation of `mh-interactive-range' to see how RANGE is read in
interactive use."
  (interactive (list (mh-interactive-range "Delete")))
  (mh-iterate-on-range () range
Bill Wohler's avatar
Bill Wohler committed
563
    (mh-delete-a-msg nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
564 565 566 567

(defun mh-execute-commands ()
  "Process outstanding delete and refile requests."
  (interactive)
Bill Wohler's avatar
Bill Wohler committed
568
  (if mh-folder-view-stack (mh-widen t))
Richard M. Stallman's avatar
Richard M. Stallman committed
569 570
  (mh-process-commands mh-current-folder)
  (mh-set-scan-mode)
Bill Wohler's avatar
Bill Wohler committed
571
  (mh-goto-cur-msg)                    ; after mh-set-scan-mode for efficiency
Richard M. Stallman's avatar
Richard M. Stallman committed
572
  (mh-make-folder-mode-line)
Bill Wohler's avatar
Bill Wohler committed
573
  t)                                    ; return t for write-file-functions
Richard M. Stallman's avatar
Richard M. Stallman committed
574 575 576 577

(defun mh-first-msg ()
  "Move to the first message."
  (interactive)
Karl Heuer's avatar
Karl Heuer committed
578
  (goto-char (point-min))
Bill Wohler's avatar
Bill Wohler committed
579
  (while (and (not (eobp)) (not (looking-at mh-scan-valid-regexp)))
Karl Heuer's avatar
Karl Heuer committed
580
    (forward-line 1)))
Richard M. Stallman's avatar
Richard M. Stallman committed
581 582 583

(defun mh-header-display ()
  "Show the current message with all its headers.
584
Displays headers that might have been suppressed by setting the
Bill Wohler's avatar
Bill Wohler committed
585
variables `mh-clean-message-header-flag' or `mhl-formfile', or by the fallback
586 587
behavior of scrolling uninteresting headers off the top of the window.
Type \"\\[mh-show]\" to show the message normally again."
Richard M. Stallman's avatar
Richard M. Stallman committed
588 589
  (interactive)
  (and (not mh-showing-with-headers)
Bill Wohler's avatar
Bill Wohler committed
590
       (or mhl-formfile mh-clean-message-header-flag)
Richard M. Stallman's avatar
Richard M. Stallman committed
591
       (mh-invalidate-show-buffer))
Bill Wohler's avatar
Bill Wohler committed
592 593
  (let ((mh-decode-mime-flag nil)
        (mhl-formfile nil)
Bill Wohler's avatar
Bill Wohler committed
594
        (mh-clean-message-header-flag nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
595 596 597 598 599 600
    (mh-show-msg nil)
    (mh-in-show-buffer (mh-show-buffer)
      (goto-char (point-min))
      (mh-recenter 0))
    (setq mh-showing-with-headers t)))

Bill Wohler's avatar
Bill Wohler committed
601
(defun mh-inc-folder (&optional maildrop-name folder)
Karl Heuer's avatar
Karl Heuer committed
602
  "Inc(orporate)s new mail into the Inbox folder.
Bill Wohler's avatar
Bill Wohler committed
603
Optional argument MAILDROP-NAME specifies an alternate maildrop from the
Bill Wohler's avatar
Bill Wohler committed
604 605
default. The optional argument FOLDER specifies where to incorporate mail
instead of the default named by `mh-inbox'.
Bill Wohler's avatar
Bill Wohler committed
606 607 608
The value of `mh-inc-folder-hook' is a list of functions to be called, with no
arguments, after incorporating new mail.
Do not call this function from outside MH-E; use \\[mh-rmail] instead."
Richard M. Stallman's avatar
Richard M. Stallman committed
609
  (interactive (list (if current-prefix-arg
Bill Wohler's avatar
Bill Wohler committed
610 611
                         (expand-file-name
                          (read-file-name "inc mail from file: "
Bill Wohler's avatar
Bill Wohler committed
612 613 614 615 616
                                          mh-user-path)))
                     (if current-prefix-arg
                         (mh-prompt-for-folder "inc mail into" mh-inbox t))))
  (if (not folder)
      (setq folder mh-inbox))
Bill Wohler's avatar
Bill Wohler committed
617 618
  (let ((threading-needed-flag nil))
    (let ((config (current-window-configuration)))
Bill Wohler's avatar
Bill Wohler committed
619 620 621 622 623 624 625
      (cond ((not (get-buffer folder))
             (mh-make-folder folder)
             (setq threading-needed-flag mh-show-threads-flag)
             (setq mh-previous-window-config config))
            ((not (eq (current-buffer) (get-buffer folder)))
             (switch-to-buffer folder)
             (setq mh-previous-window-config config))))
Bill Wohler's avatar
Bill Wohler committed
626 627 628 629 630
    (mh-get-new-mail maildrop-name)
    (when (and threading-needed-flag
               (save-excursion
                 (goto-char (point-min))
                 (or (null mh-large-folder)
Bill Wohler's avatar
Bill Wohler committed
631
                     (not (equal (forward-line (1+ mh-large-folder)) 0))
Bill Wohler's avatar
Bill Wohler committed
632 633 634
                     (and (message "Not threading since the number of messages exceeds `mh-large-folder'")
                          nil))))
      (mh-toggle-threads))
Bill Wohler's avatar
Bill Wohler committed
635 636
    (beginning-of-line)
    (if (and mh-showing-mode (looking-at mh-scan-valid-regexp)) (mh-show))
Bill Wohler's avatar
Bill Wohler committed
637
    (run-hooks 'mh-inc-folder-hook)))
Richard M. Stallman's avatar
Richard M. Stallman committed
638 639 640 641 642

(defun mh-last-msg ()
  "Move to the last message."
  (interactive)
  (goto-char (point-max))
Bill Wohler's avatar
Bill Wohler committed
643
  (while (and (not (bobp)) (not (looking-at mh-scan-valid-regexp)))
Bill Wohler's avatar
Bill Wohler committed
644 645
    (forward-line -1))
  (mh-recenter nil))
Richard M. Stallman's avatar
Richard M. Stallman committed
646

Bill Wohler's avatar
Bill Wohler committed
647 648 649 650
(defun mh-next-undeleted-msg (&optional arg wait-after-complaining-flag)
  "Move to the next undeleted message ARG in window.
If optional argument WAIT-AFTER-COMPLAINING-FLAG is non-nil and we are at the
last undeleted message then pause for a second after printing message."
Karl Heuer's avatar
Karl Heuer committed
651
  (interactive "p")
Richard M. Stallman's avatar
Richard M. Stallman committed
652
  (setq mh-next-direction 'forward)
Karl Heuer's avatar
Karl Heuer committed
653
  (forward-line 1)
Bill Wohler's avatar
Bill Wohler committed
654
  (cond ((re-search-forward mh-scan-good-msg-regexp nil t arg)
Bill Wohler's avatar
Bill Wohler committed
655 656 657
         (beginning-of-line)
         (mh-maybe-show))
        (t (forward-line -1)
Bill Wohler's avatar
Bill Wohler committed
658 659
           (message "No more undeleted messages")
           (if wait-after-complaining-flag (sit-for 1)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
660

Bill Wohler's avatar
Bill Wohler committed
661 662 663 664 665
(defun mh-folder-from-address ()
  "Determine folder name from address in From field.
Takes the address in the From: header field, and returns one of:

  a) The folder name associated with the address in the alist
Bill Wohler's avatar
Bill Wohler committed
666 667 668 669 670
     `mh-default-folder-list'.  If the `Check Recipient' boolean
      is set, then the `mh-default-folder-list' addresses are
      checked against the recipient instead of the originator
      (making possible to use this feature for mailing lists).
      The first match found in `mh-default-folder-list' is used.
Bill Wohler's avatar
Bill Wohler committed
671 672 673 674 675 676

  b) The address' corresponding alias from the user's personal
     aliases file prefixed by `mh-default-folder-prefix'.

Returns nil if the address was not found in either place or if the variable
`mh-default-folder-must-exist-flag' is nil and the folder does not exist."
Bill Wohler's avatar
Bill Wohler committed
677
  ;; Loop for all entries in mh-default-folder-list
Bill Wohler's avatar
Bill Wohler committed
678 679 680 681 682 683 684 685 686 687 688 689 690
  (save-restriction
    (goto-char (point-min))
    (re-search-forward "\n\n" nil t)
    (narrow-to-region (point-min) (point))
    (let ((to/cc (concat (or (message-fetch-field "to") "") ", "
                         (or (message-fetch-field "cc") "")))
          (from (or (message-fetch-field "from") ""))
          folder-name)
      (setq folder-name
            (loop for list in mh-default-folder-list
                  when (string-match (nth 0 list) (if (nth 2 list) to/cc from))
                  return (nth 1 list)
                  finally return nil))
Bill Wohler's avatar
Bill Wohler committed
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712

      ;; Make sure a result from `mh-default-folder-list' begins with "+"
      ;; since 'mh-expand-file-name below depends on it
      (when (and folder-name (not (eq (aref folder-name 0) ?+)))
        (setq folder-name (concat "+" folder-name)))

      ;; If not, is there an alias for the address?
      (when (not folder-name)
        (let* ((from-header (mh-extract-from-header-value))
               (address (and from-header
                             (nth 1 (mail-extract-address-components
                                     from-header))))
               (alias (and address (mh-alias-address-to-alias address))))
          (when alias
            (setq folder-name
                  (and alias (concat "+" mh-default-folder-prefix alias))))))

      ;; If mh-default-folder-must-exist-flag set, check that folder exists.
      (if (and folder-name
               (or (not mh-default-folder-must-exist-flag)
                   (file-exists-p (mh-expand-file-name folder-name))))
          folder-name))))
Bill Wohler's avatar
Bill Wohler committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738

(defun mh-prompt-for-refile-folder ()
  "Prompt the user for a folder in which the message should be filed.
The folder is returned as a string.

If `mh-default-folder-for-message-function' is a function then the message
being refiled is yanked into a temporary buffer and the function is called to
intelligently guess where the message is to be refiled.

Otherwise, a default folder name is generated by `mh-folder-from-address'."
  (mh-prompt-for-folder
   "Destination"
   (let ((refile-file (mh-msg-filename (mh-get-msg-num t))))
     (save-excursion
       (set-buffer (get-buffer-create mh-temp-buffer))
       (erase-buffer)
       (insert-file-contents refile-file)
       (or (and mh-default-folder-for-message-function
                (let ((buffer-file-name refile-file))
                  (funcall mh-default-folder-for-message-function)))
           (mh-folder-from-address)
           (and (eq 'refile (car mh-last-destination-folder))
                (symbol-name (cdr mh-last-destination-folder)))
           "")))
   t))

Bill Wohler's avatar
Bill Wohler committed
739 740 741 742 743
(defun mh-refile-msg (range folder &optional dont-update-last-destination-flag)
  "Refile RANGE into FOLDER.

Check the documentation of `mh-interactive-range' to see how RANGE is read in
interactive use.
Bill Wohler's avatar
Bill Wohler committed
744 745 746 747

If optional argument DONT-UPDATE-LAST-DESTINATION-FLAG is non-nil then the
variables `mh-last-destination' and `mh-last-destination-folder' are not
updated."
Bill Wohler's avatar
Bill Wohler committed
748
  (interactive (list (mh-interactive-range "Refile")
Bill Wohler's avatar
Bill Wohler committed
749 750 751 752
                     (intern (mh-prompt-for-refile-folder))))
  (unless dont-update-last-destination-flag
    (setq mh-last-destination (cons 'refile folder)
          mh-last-destination-folder mh-last-destination))
Bill Wohler's avatar
Bill Wohler committed
753
  (mh-iterate-on-range () range
Bill Wohler's avatar
Bill Wohler committed
754
    (mh-refile-a-msg nil folder))
Bill Wohler's avatar
Bill Wohler committed
755
  (when (looking-at mh-scan-refiled-msg-regexp) (mh-next-msg)))
Richard M. Stallman's avatar
Richard M. Stallman committed
756

Karl Heuer's avatar
Karl Heuer committed
757
(defun mh-refile-or-write-again (message)
Richard M. Stallman's avatar
Richard M. Stallman committed
758
  "Re-execute the last refile or write command on the given MESSAGE.
Bill Wohler's avatar
Bill Wohler committed
759 760
Default is the displayed message. Use the same folder or file as the previous
refile or write command."
Richard M. Stallman's avatar
Richard M. Stallman committed
761 762 763
  (interactive (list (mh-get-msg-num t)))
  (if (null mh-last-destination)
      (error "No previous refile or write"))
Bill Wohler's avatar
Bill Wohler committed
764 765 766 767 768 769 770 771 772 773
  (let (output)
    (setq output
          (cond ((eq (car mh-last-destination) 'refile)
                 (mh-refile-a-msg message (cdr mh-last-destination))
                 (format "Destination folder: %s" (cdr mh-last-destination)))
                (t
                 (apply 'mh-write-msg-to-file message (cdr mh-last-destination))
                 (format "Destination: %s" (cdr mh-last-destination)))))
    (mh-next-msg (interactive-p))
    (message output)))
Richard M. Stallman's avatar
Richard M. Stallman committed
774 775

(defun mh-quit ()
Bill Wohler's avatar
Bill Wohler committed
776 777 778 779 780
  "Quit the current MH-E folder.
Restore the previous window configuration, if one exists.
The value of `mh-before-quit-hook' is a list of functions to be called, with
no arguments, immediately upon entry to this function.
The value of `mh-quit-hook' is a list of functions to be called, with no
Bill Wohler's avatar
Bill Wohler committed
781 782 783
arguments, upon exit of this function.
MH-E working buffers (whose name begins with \" *mh-\" or \"*MH-E \") are
killed."
Richard M. Stallman's avatar
Richard M. Stallman committed
784
  (interactive)
Bill Wohler's avatar
Bill Wohler committed
785
  (run-hooks 'mh-before-quit-hook)
Bill Wohler's avatar
Bill Wohler committed
786 787 788
  (let ((show-buffer (get-buffer mh-show-buffer)))
    (when show-buffer
      (kill-buffer show-buffer)))
Karl Heuer's avatar
Karl Heuer committed
789
  (mh-update-sequences)
Bill Wohler's avatar
Bill Wohler committed
790
  (mh-destroy-postponed-handles)
791
  (bury-buffer (current-buffer))
Bill Wohler's avatar
Bill Wohler committed
792 793 794 795 796 797 798

  ;; Delete all MH-E temporary and working buffers.
  (dolist (buffer (buffer-list))
    (when (or (string-match "^ \\*mh-" (buffer-name buffer))
              (string-match "^\\*MH-E " (buffer-name buffer)))
      (kill-buffer buffer)))

Richard M. Stallman's avatar
Richard M. Stallman committed
799 800 801 802 803 804
  (if mh-previous-window-config
      (set-window-configuration mh-previous-window-config))
  (run-hooks 'mh-quit-hook))

(defun mh-page-msg (&optional arg)
  "Page the displayed message forwards.
Bill Wohler's avatar
Bill Wohler committed
805 806 807
Scrolls ARG lines or a full screen if no argument is supplied. Show buffer
first if not displayed. Show the next undeleted message if looking at the
bottom of the current message."
Richard M. Stallman's avatar
Richard M. Stallman committed
808
  (interactive "P")
Bill Wohler's avatar
Bill Wohler committed
809
  (if mh-showing-mode
Bill Wohler's avatar
Bill Wohler committed
810
      (if mh-page-to-next-msg-flag
Bill Wohler's avatar
Bill Wohler committed
811 812 813 814 815 816 817 818 819 820 821 822 823 824
          (if (equal mh-next-direction 'backward)
              (mh-previous-undeleted-msg)
            (mh-next-undeleted-msg))
        (if (mh-in-show-buffer (mh-show-buffer)
              (pos-visible-in-window-p (point-max)))
            (progn
              (message (format
                        "End of message (Type %s to read %s undeleted message)"
                        (single-key-description last-input-event)
                        (if (equal mh-next-direction 'backward)
                            "previous"
                          "next")))
              (setq mh-page-to-next-msg-flag t))
          (scroll-other-window arg)))
Bill Wohler's avatar
Bill Wohler committed
825
    (mh-show)))
Richard M. Stallman's avatar
Richard M. Stallman committed
826 827 828 829 830 831 832 833

(defun mh-previous-page (&optional arg)
  "Page the displayed message backwards.
Scrolls ARG lines or a full screen if no argument is supplied."
  (interactive "P")
  (mh-in-show-buffer (mh-show-buffer)
    (scroll-down arg)))

Bill Wohler's avatar
Bill Wohler committed
834 835 836 837
(defun mh-previous-undeleted-msg (&optional arg wait-after-complaining-flag)
  "Move to the previous undeleted message ARG in window.
If optional argument WAIT-AFTER-COMPLAINING-FLAG is non-nil and we are at the
first undeleted message then pause for a second after printing message."
Richard M. Stallman's avatar
Richard M. Stallman committed
838 839 840
  (interactive "p")
  (setq mh-next-direction 'backward)
  (beginning-of-line)
Bill Wohler's avatar
Bill Wohler committed
841
  (cond ((re-search-backward mh-scan-good-msg-regexp nil t arg)
Bill Wohler's avatar
Bill Wohler committed
842
         (mh-maybe-show))
Bill Wohler's avatar
Bill Wohler committed
843 844
        (t (message "No previous undeleted message")
           (if wait-after-complaining-flag (sit-for 1)))))
Bill Wohler's avatar
Bill Wohler committed
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875

(defun mh-previous-unread-msg (&optional count)
  "Move to previous unread message.
With optional argument COUNT, COUNT-1 unread messages before current message
are skipped."
  (interactive "p")
  (unless (> count 0)
    (error "The function mh-previous-unread-msg expects positive argument"))
  (setq count (1- count))
  (let ((unread-sequence (cdr (assoc mh-unseen-seq mh-seq-list)))
        (cur-msg (mh-get-msg-num nil)))
    (cond ((and (not cur-msg) (not (bobp))
                ;; If we are at the end of the buffer back up one line and go
                ;; to unread message after that.
                (progn
                  (forward-line -1)
                  (setq cur-msg (mh-get-msg-num nil)))
                nil))
          ((or (null unread-sequence) (not cur-msg))
           ;; No unread message or there aren't any messages in buffer...
           (message "No more unread messages"))
          ((progn
             ;; Skip count messages...
             (while (and unread-sequence (>= (car unread-sequence) cur-msg))
               (setq unread-sequence (cdr unread-sequence)))
             (while (> count 0)
               (setq unread-sequence (cdr unread-sequence))
               (setq count (1- count)))
             (not (car unread-sequence)))
           (message "No more unread messages"))
          (t (mh-goto-msg (car unread-sequence))))))
Bill Wohler's avatar
Bill Wohler committed
876 877 878 879 880 881 882 883 884 885 886 887 888 889

(defun mh-goto-next-button (backward-flag &optional criterion)
  "Search for next button satisfying criterion.
If BACKWARD-FLAG is non-nil search backward in the buffer for a mime button. If
CRITERION is a function or a symbol which has a function binding then that
function must return non-nil at the button we stop."
  (unless (or (and (symbolp criterion) (fboundp criterion))
              (functionp criterion))
    (setq criterion (lambda (x) t)))
  ;; Move to the next button in the buffer satisfying criterion
  (goto-char (or (save-excursion
                   (beginning-of-line)
                   ;; Find point before current button
                   (let ((point-before-current-button
Bill Wohler's avatar
Bill Wohler committed
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
                          (save-excursion
                            (while (get-text-property (point) 'mh-data)
                              (unless (= (forward-line
                                          (if backward-flag 1 -1))
                                         0)
                                (if backward-flag
                                    (goto-char (point-min))
                                  (goto-char (point-max)))))
                            (point))))
                     ;; Skip over current button
                     (while (and (get-text-property (point) 'mh-data)
                                 (not (if backward-flag (bobp) (eobp))))
                       (forward-line (if backward-flag -1 1)))
                     ;; Stop at next MIME button if any exists.
                     (block loop
                       (while (/= (progn
                                    (unless (= (forward-line
                                                (if backward-flag -1 1))
                                               0)
                                      (if backward-flag
                                          (goto-char (point-max))
                                        (goto-char (point-min)))
                                      (beginning-of-line))
                                    (point))
                                  point-before-current-button)
                         (when (and (get-text-property (point) 'mh-data)
                                    (funcall criterion (point)))
                           (return-from loop (point))))
                       nil)))
Bill Wohler's avatar
Bill Wohler committed
919 920 921 922 923 924 925 926 927 928 929 930 931
                 (point))))

(defun mh-next-button (&optional backward-flag)
  "Go to the next MIME button.
Advance point to the next MIME button in the show buffer. If the end
of buffer is reached then the search wraps over to the start of the
buffer. With prefix argument, BACKWARD-FLAG the point will move to the
previous MIME button."
  (interactive (list current-prefix-arg))
  (unless mh-showing-mode
    (mh-show))
  (mh-in-show-buffer (mh-show-buffer)
    (mh-goto-next-button backward-flag)))
Richard M. Stallman's avatar
Richard M. Stallman committed
932

Bill Wohler's avatar
Bill Wohler committed
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950
(defun mh-prev-button ()
  "Go to the prev MIME button.
Move point to the previous MIME button in the show buffer. If the beginning
of the buffer is reached then the search wraps over to the end of the
buffer."
  (interactive)
  (mh-next-button t))

(defun mh-folder-mime-action (part-index action include-security-flag)
  "Go to PART-INDEX and carry out ACTION.
If PART-INDEX is nil then go to the next part in the buffer. The search for
the next buffer wraps around if end of buffer is reached. If argument
INCLUDE-SECURITY-FLAG is non-nil then include security info buttons when
searching for a suitable parts."
  (unless mh-showing-mode
    (mh-show))
  (mh-in-show-buffer (mh-show-buffer)
    (let ((criterion
Bill Wohler's avatar
Bill Wohler committed
951 952 953 954 955 956 957 958
           (cond (part-index
                  (lambda (p)
                    (let ((part (get-text-property p 'mh-part)))
                      (and (integerp part) (= part part-index)))))
                 (t (lambda (p)
                      (if include-security-flag
                          (get-text-property p 'mh-data)
                        (integerp (get-text-property p 'mh-part)))))))
Bill Wohler's avatar
Bill Wohler committed
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
          (point (point)))
      (cond ((and (get-text-property point 'mh-part)
                  (or (null part-index)
                      (= (get-text-property point 'mh-part) part-index)))
             (funcall action))
            ((and (get-text-property point 'mh-data)
                  include-security-flag
                  (null part-index))
             (funcall action))
            (t
             (mh-goto-next-button nil criterion)
             (if (= (point) point)
                 (message "No matching MIME part found")
               (funcall action)))))))

(defun mh-folder-toggle-mime-part (part-index)
  "Toggle display of button.
If point in show buffer is at a button then that part is toggled.
If not at a button and PART-INDEX is non-nil point is moved to that part.
With nil PART-INDEX find the first button after point (search wraps around if
end of buffer is reached) and toggle it."
  (interactive "P")
  (when (consp part-index) (setq part-index (car part-index)))
  (mh-folder-mime-action part-index #'mh-press-button t))

(defun mh-folder-inline-mime-part (part-index)
  "Show the raw bytes of MIME part inline.
If point in show buffer is at a mime part then that part is inlined.
If not at a mime-part and PART-INDEX is non-nil point is moved to that part.
With nil PART-INDEX find the first button after point (search wraps around if
end of buffer is reached) and inline it."
  (interactive "P")
  (when (consp part-index) (setq part-index (car part-index)))
  (mh-folder-mime-action part-index #'mh-mime-inline-part nil))

(defun mh-folder-save-mime-part (part-index)
  "Save MIME part.
If point in show buffer is at a mime part then that part is saved.
If not at a mime-part and PART-INDEX is non-nil point is moved to that part.
With nil PART-INDEX find the first button after point (search wraps around if
end of buffer is reached) and save it."
  (interactive "P")
  (when (consp part-index) (setq part-index (car part-index)))
  (mh-folder-mime-action part-index #'mh-mime-save-part nil))

Bill Wohler's avatar
Bill Wohler committed
1004 1005
(defvar mh-thread-scan-line-map-stack)

Bill Wohler's avatar
Bill Wohler committed
1006 1007 1008 1009
(defun mh-reset-threads-and-narrowing ()
  "Reset all variables pertaining to threads and narrowing.
Also removes all content from the folder buffer."
  (setq mh-view-ops ())
Bill Wohler's avatar
Bill Wohler committed
1010 1011
  (setq mh-folder-view-stack ())
  (setq mh-thread-scan-line-map-stack ())
Bill Wohler's avatar
Bill Wohler committed
1012
  (let ((buffer-read-only nil)) (erase-buffer)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1013

Bill Wohler's avatar
Bill Wohler committed
1014
(defun mh-rescan-folder (&optional range dont-exec-pending)
Richard M. Stallman's avatar
Richard M. Stallman committed
1015
  "Rescan a folder after optionally processing the outstanding commands.
Bill Wohler's avatar
Bill Wohler committed
1016
If optional prefix argument RANGE is provided, prompt for the range of
Bill Wohler's avatar
Bill Wohler committed
1017 1018 1019
messages to display. Otherwise show the entire folder.
If optional argument DONT-EXEC-PENDING is non-nil then pending deletes and
refiles aren't carried out."
Richard M. Stallman's avatar
Richard M. Stallman committed
1020
  (interactive (list (if current-prefix-arg
Bill Wohler's avatar
Bill Wohler committed
1021 1022
                         (mh-read-range "Rescan" mh-current-folder t nil t
                                        mh-interpret-number-as-range-flag)
Bill Wohler's avatar
Bill Wohler committed
1023
                       nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1024
  (setq mh-next-direction 'forward)
Bill Wohler's avatar
Bill Wohler committed
1025 1026 1027 1028
  (let ((threaded-flag (memq 'unthread mh-view-ops)))
    (mh-scan-folder mh-current-folder (or range "all") dont-exec-pending)
    (cond (threaded-flag (mh-toggle-threads))
          (mh-index-data (mh-index-insert-folder-headers)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1029 1030

(defun mh-write-msg-to-file (msg file no-headers)
Bill Wohler's avatar
Bill Wohler committed
1031 1032
  "Append MSG to the end of a FILE.
If prefix argument NO-HEADERS is provided, write only the message body.
Richard M. Stallman's avatar
Richard M. Stallman committed
1033 1034 1035
Otherwise send the entire message including the headers."
  (interactive
   (list (mh-get-msg-num t)
Bill Wohler's avatar
Bill Wohler committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046
         (let ((default-dir (if (eq 'write (car mh-last-destination-write))
                                (file-name-directory
                                 (car (cdr mh-last-destination-write)))
                              default-directory)))
           (read-file-name (format "Save message%s in file: "
                                   (if current-prefix-arg " body" ""))
                           default-dir
                           (if (eq 'write (car mh-last-destination-write))
                               (car (cdr mh-last-destination-write))
                             (expand-file-name "mail.out" default-dir))))
         current-prefix-arg))
Karl Heuer's avatar
Karl Heuer committed
1047
  (let ((msg-file-to-output (mh-msg-filename msg))
Bill Wohler's avatar
Bill Wohler committed
1048
        (output-file (mh-expand-file-name file)))
Bill Wohler's avatar
Bill Wohler committed
1049
    (setq mh-last-destination (list 'write file (if no-headers 'no-headers))
Bill Wohler's avatar
Bill Wohler committed
1050
          mh-last-destination-write mh-last-destination)
Richard M. Stallman's avatar
Richard M. Stallman committed
1051
    (save-excursion
Karl Heuer's avatar
Karl Heuer committed
1052
      (set-buffer (get-buffer-create mh-temp-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
1053
      (erase-buffer)
Karl Heuer's avatar
Karl Heuer committed
1054
      (insert-file-contents msg-file-to-output)
Richard M. Stallman's avatar
Richard M. Stallman committed
1055 1056 1057 1058 1059 1060 1061
      (goto-char (point-min))
      (if no-headers (search-forward "\n\n"))
      (append-to-file (point) (point-max) output-file))))

(defun mh-toggle-showing ()
  "Toggle the scanning mode/showing mode of displaying messages."
  (interactive)
Bill Wohler's avatar
Bill Wohler committed
1062
  (if mh-showing-mode
Richard M. Stallman's avatar
Richard M. Stallman committed
1063
      (mh-set-scan-mode)
Bill Wohler's avatar
Bill Wohler committed
1064
    (mh-show)))
Richard M. Stallman's avatar
Richard M. Stallman committed
1065

Bill Wohler's avatar
Bill Wohler committed
1066 1067 1068 1069 1070 1071 1072
(defun mh-undo (range)
  "Undo the pending deletion or refile of the specified RANGE.

Check the documentation of `mh-interactive-range' to see how RANGE is read in
interactive use."
  (interactive (list (mh-interactive-range "Undo")))
  (cond ((numberp range)
Bill Wohler's avatar
Bill Wohler committed
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
         (let ((original-position (point)))
           (beginning-of-line)
           (while (not (or (looking-at mh-scan-deleted-msg-regexp)
                           (looking-at mh-scan-refiled-msg-regexp)
                           (and (eq mh-next-direction 'forward) (bobp))
                           (and (eq mh-next-direction 'backward)
                                (save-excursion (forward-line) (eobp)))))
             (forward-line (if (eq mh-next-direction 'forward) -1 1)))
           (if (or (looking-at mh-scan-deleted-msg-regexp)
                   (looking-at mh-scan-refiled-msg-regexp))
               (progn
                 (mh-undo-msg (mh-get-msg-num t))
                 (mh-maybe-show))
             (goto-char original-position)
             (error "Nothing to undo"))))
Bill Wohler's avatar
Bill Wohler committed
1088
        (t (mh-iterate-on-range () range
Bill Wohler's avatar
Bill Wohler committed
1089
             (mh-undo-msg nil))))
Richard M. Stallman's avatar
Richard M. Stallman committed
1090 1091 1092
  (if (not (mh-outstanding-commands-p))
      (mh-set-folder-modified-p nil)))

Bill Wohler's avatar
Bill Wohler committed
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
;;;###mh-autoload
(defun mh-folder-line-matches-show-buffer-p ()
  "Return t if the message under point in folder-mode is in the show buffer.
Return nil in any other circumstance (no message under point, no show buffer,
the message in the show buffer doesn't match."
  (and (eq major-mode 'mh-folder-mode)
       (mh-get-msg-num nil)
       mh-show-buffer
       (get-buffer mh-show-buffer)
       (buffer-file-name (get-buffer mh-show-buffer))
       (string-match ".*/\\([0-9]+\\)$"
                     (buffer-file-name (get-buffer mh-show-buffer)))
       (string-equal
        (match-string 1 (buffer-file-name (get-buffer mh-show-buffer)))
        (int-to-string (mh-get-msg-num nil)))))

(eval-when-compile (require 'gnus))

(defmacro mh-macro-expansion-time-gnus-version ()
  "Return Gnus version available at macro expansion time.
The macro evaluates the Gnus version at macro expansion time. If MH-E was
compiled then macro expansion happens at compile time."
  gnus-version)

(defun mh-run-time-gnus-version ()
  "Return Gnus version available at run time."
  (require 'gnus)
  gnus-version)

Karl Heuer's avatar
Karl Heuer committed
1122
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
1123
(defun mh-version ()
Bill Wohler's avatar
Bill Wohler committed
1124
  "Display version information about MH-E and the MH mail handling system."
Richard M. Stallman's avatar
Richard M. Stallman committed
1125 1126
  (interactive)
  (mh-find-progs)
Bill Wohler's avatar
Bill Wohler committed
1127
  (set-buffer (get-buffer-create mh-info-buffer))
Richard M. Stallman's avatar
Richard M. Stallman committed
1128
  (erase-buffer)
Bill Wohler's avatar
Bill Wohler committed
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
  ;; MH-E version.
  (insert "MH-E " mh-version "\n\n")
  ;; MH-E compilation details.
  (insert "MH-E compilation details:\n")
  (let* ((compiled-mhe (byte-code-function-p (symbol-function 'mh-version)))
         (gnus-compiled-version (if compiled-mhe
                                    (mh-macro-expansion-time-gnus-version)
                                  "N/A")))
    (insert " Byte compiled:\t\t" (if compiled-mhe "yes" "no") "\n"
            " Gnus (compile-time):\t" gnus-compiled-version "\n"
            " Gnus (run-time):\t" (mh-run-time-gnus-version) "\n\n"))
  ;; Emacs version.
  (insert (emacs-version) "\n\n")
Bill Wohler's avatar
Bill Wohler committed
1142
  ;; MH version.
Richard M. Stallman's avatar
Richard M. Stallman committed
1143 1144
  (let ((help-start (point)))
    (condition-case err-data
Bill Wohler's avatar
Bill Wohler committed
1145
        (mh-exec-cmd-output "inc" nil (if mh-nmh-flag "-version" "-help"))