| blob | 6c08d5ca4117d3e2161cfae9a995ac6d5033703a |
1 ;;; mailabbrev.el --- abbrev-expansion of mail aliases.
3 ;; Copyright (C) 1985, 86, 87, 92, 93, 96, 1997, 2000
4 ;; Free Software Foundation, Inc.
6 ;; Author: Jamie Zawinski <jwz@lucid.com>, now <jwz@jwz.org>
7 ;; Maintainer: FSF
8 ;; Created: 19 Oct 90
9 ;; Keywords: mail
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; This file ensures that, when the point is in a To:, CC:, BCC:, or From:
31 ;; field, word-abbrevs are defined for each of your mail aliases. These
32 ;; aliases will be defined from your .mailrc file (or the file specified by
33 ;; the MAILRC environment variable) if it exists. Your mail aliases will
34 ;; expand any time you type a word-delimiter at the end of an abbreviation.
35 ;;
36 ;; What you see is what you get: if mailabbrev is in use when you type
37 ;; a name, and the name does not expand, you know it is not an abbreviation.
38 ;; However, if you yank abbreviations into the headers
39 ;; in a way that bypasses the check for abbreviations,
40 ;; they are expanded (but not visibly) when you send the message.
41 ;;
42 ;; Your mail alias abbrevs will be in effect only when the point is in an
43 ;; appropriate header field. When in the body of the message, or other
44 ;; header fields, the mail aliases will not expand. Rather, the normal
45 ;; mode-specific abbrev table (mail-mode-abbrev-table) will be used if
46 ;; defined. So if you use mail-mode specific abbrevs, this code will not
47 ;; adversely affect you. You can control which header fields the abbrevs
48 ;; are used in by changing the variable mail-abbrev-mode-regexp.
49 ;;
50 ;; If auto-fill mode is on, abbrevs will wrap at commas instead of at word
51 ;; boundaries; also, header continuation-lines will be properly indented.
52 ;;
53 ;; You can also insert a mail alias with mail-abbrev-insert-alias
54 ;; (bound to C-c C-a), which prompts you for an alias (with completion)
55 ;; and inserts its expansion at point.
56 ;;
57 ;; This file fixes a bug in the old system which prohibited your .mailrc
58 ;; file from having lines like
59 ;;
60 ;; alias someone "John Doe <doe@quux.com>"
61 ;;
62 ;; That is, if you want an address to have embedded spaces, simply surround it
63 ;; with double-quotes. This is necessary because the format of the .mailrc
64 ;; file bogusly uses spaces as address delimiters. The following line defines
65 ;; an alias which expands to three addresses:
66 ;;
67 ;; alias foobar addr-1 addr-2 "address three <addr-3>"
68 ;;
69 ;; (This is bogus because mail-delivery programs want commas, not spaces,
70 ;; but that's what the file format is, so we have to live with it.)
71 ;;
72 ;; If you like, you can call the function define-mail-abbrev to define your
73 ;; mail aliases instead of using a .mailrc file. When you call it in this
74 ;; way, addresses are separated by commas.
75 ;;
76 ;; CAVEAT: This works on most Sun systems; I have been told that some versions
77 ;; of /bin/mail do not understand double-quotes in the .mailrc file. So you
78 ;; should make sure your version does before including verbose addresses like
79 ;; this. One solution to this, if you are on a system whose /bin/mail doesn't
80 ;; work that way, (and you still want to be able to /bin/mail to send mail in
81 ;; addition to emacs) is to define minimal aliases (without full names) in
82 ;; your .mailrc file, and use define-mail-abbrev to redefine them when sending
83 ;; mail from emacs; this way, mail sent from /bin/mail will work, and mail
84 ;; sent from emacs will be pretty.
85 ;;
86 ;; Aliases in the mailrc file may be nested. If you define aliases like
87 ;; alias group1 fred ethel
88 ;; alias group2 larry curly moe
89 ;; alias everybody group1 group2
90 ;; Then when you type "everybody" on the To: line, it will be expanded to
91 ;; fred, ethyl, larry, curly, moe
92 ;;
93 ;; Aliases may also contain forward references; the alias of "everybody" can
94 ;; precede the aliases of "group1" and "group2".
95 ;;
96 ;; This code also understands the "source" .mailrc command, for reading
97 ;; aliases from some other file as well.
98 ;;
99 ;; Aliases may contain hyphens, as in "alias foo-bar foo@bar"; word-abbrevs
100 ;; normally cannot contain hyphens, but this code works around that for the
101 ;; specific case of mail-alias word-abbrevs.
102 ;;
103 ;; To read in the contents of another .mailrc-type file from emacs, use the
104 ;; command Meta-X merge-mail-abbrevs. The rebuild-mail-abbrevs command is
105 ;; similar, but will delete existing aliases first.
106 ;;
107 ;; If you would like your aliases to be expanded when you type M-> or ^N to
108 ;; move out of the mail-header into the message body (instead of having to
109 ;; type SPC at the end of the abbrev before moving away) then you can do
110 ;;
111 ;; (add-hook
112 ;; 'mail-setup-hook
113 ;; (lambda ()
114 ;; (substitute-key-definition 'next-line 'mail-abbrev-next-line
115 ;; mail-mode-map global-map)
116 ;; (substitute-key-definition 'end-of-buffer 'mail-abbrev-end-of-buffer
117 ;; mail-mode-map global-map)))
118 ;;
119 ;; If you want multiple addresses separated by a string other than ", " then
120 ;; you can set the variable mail-alias-separator-string to it. This has to
121 ;; be a comma bracketed by whitespace if you want any kind of reasonable
122 ;; behaviour.
123 ;;
124 ;; Thanks to Harald Hanche-Olsen, Michael Ernst, David Loeffler, and
125 ;; Noah Friedman for suggestions and bug reports.
127 ;; To use this package, do (add-hook 'mail-setup-hook 'mail-abbrevs-setup).
129 ;;; Code:
134 "Expand mail aliases as abbrevs, in certain mail headers."
138 "*Non-nil means expand mail aliases as abbrevs, in certain message headers."
149 "*Non-nil means only mail abbrevs should expand automatically.
150 Other abbrevs expand only when you explicitly use `expand-abbrev'."
154 ;; originally defined in sendmail.el - used to be an alist, now is a table.
156 "Word-abbrev table of mail address aliases.
157 If this is nil, it means the aliases have not yet been initialized and
158 should be read from the .mailrc file. (This is distinct from there being
172 ;;;###autoload
174 "Initialize use of the `mailabbrev' package."
184 nil t)
191 "Turn off use of the `mailabbrev' package."
195 ;;;###autoload
197 "Read mail aliases from personal mail alias file and set `mail-abbrevs'.
198 By default this is the file specified by `mail-personal-alias-file'."
201 nil
218 ;; Don't lose if no final newline.
222 ;; Delete comments from the file
228 ;; handle "\\\n" continuation lines
244 t))
250 ; (message "** %s \"%s\"" name (buffer-substring start (point)))(sit-for 1)
252 name
254 t))))
255 ;; Resolve forward references in .mailrc file.
256 ;; This would happen automatically before the first abbrev was
257 ;; expanded, but why not do it now.
259 mail-abbrevs)
265 "*A string inserted between addresses in multi-address mail aliases.
269 ;; define-mail-abbrev sets this flag, which causes mail-resolve-all-aliases
270 ;; to be called before expanding abbrevs if it's necessary.
273 ;; originally defined in mailalias.el ; build-mail-abbrevs calls this with
274 ;; stuff parsed from the .mailrc file.
275 ;;
276 ;;;###autoload
278 "Define NAME as a mail alias abbrev that translates to DEFINITION.
279 If DEFINITION contains multiple addresses, separate them with commas."
280 ;; When this is called from build-mail-abbrevs, the third argument is
281 ;; true, and we do some evil space->comma hacking like /bin/mail does.
283 ;; Read the defaults first, if we have not done so.
285 nil
290 ;; strip garbage from front and end
298 end)
300 ;; If we're reading from the mailrc file, then addresses are delimited
301 ;; by spaces, and addresses with embedded spaces must be surrounded by
302 ;; double-quotes. Otherwise, addresses are separated by commas.
315 mail-alias-separator-string)))
318 ;; use an abbrev table instead of an alist for mail-abbrevs.
324 "Resolve all forward references in the mail aliases table."
327 ;; (message "Resolving mail aliases...")
331 ;; (message "Resolving mail aliases... done.")
332 )))
351 x)))
353 mail-alias-separator-string))
359 "For use as the fourth arg to `define-abbrev'.
360 After expanding a mail-abbrev, if Auto Fill mode is on and we're past the
361 fill-column, break the line at the previous comma, and indent the next line."
362 ;; Disable abbrev mode to avoid recursion in indent-relative expanding
363 ;; part of the abbrev expansion as an abbrev itself.
367 bol comma fp)
381 ;; Go to the end of the new line.
384 ;; It's still too long; do normal auto-fill.
387 ;; Resume the search.
389 )))))
390 \f
391 ;;; Syntax tables and abbrev-expansion
395 "*Regexp to select mail-headers in which mail abbrevs should be expanded.
396 This string will be handed to `looking-at' with point at the beginning
397 of the current line; if it matches, abbrev mode will be turned on, otherwise
398 it will be turned off. (You don't need to worry about continuation lines.)
399 This should be set to match those mail fields in which you want abbreviations
404 ;; This makes the characters "@%!._-" be considered symbol-constituents
405 ;; but not word-constituents, so forward-sexp will move you over an
406 ;; entire address, but forward-word will only move you over a sequence
407 ;; of alphanumerics. (Clearly the right thing.)
416 tab)
417 "The syntax table used in send-mail mode when in a mail-address header.
418 `mail-mode-syntax-table' is used when the cursor is in the message body or in
429 tab)
430 tab)
431 "The syntax-table used for abbrev-expansion purposes.
432 This is not actually made the current syntax table of the buffer, but
433 simply controls the set of characters which may be a part of the name
438 "Whether point is in a mail-address header field."
441 ;; we are on an appropriate header line...
444 ;; skip backwards over continuation lines.
448 ;; are we at the front of an appropriate header line?
450 ;;
451 ;; ...and are we in the headers?
460 ;;
461 ;; We are in a To: (or CC:, or whatever) header, and
462 ;; should use word-abbrevs to expand mail aliases.
464 ;; Before anything else, resolve aliases if they need it.
468 ;; Now proceed with the abbrev section.
469 ;; - First, install the mail-abbrevs as the word-abbrev table.
470 ;; - Then install the mail-abbrev-syntax-table, which
471 ;; temporarily marks all of the
472 ;; non-alphanumeric-atom-characters (the "_"
473 ;; syntax ones) as being normal word-syntax. We do this
474 ;; because the C code for expand-abbrev only works on words,
475 ;; and we want these characters to be considered words for
476 ;; the purpose of abbrev expansion.
477 ;; - Then we call expand-abbrev again, recursively, to do
478 ;; the abbrev expansion with the above syntax table.
479 ;; - Then we do a trick which tells the expand-abbrev frame
480 ;; which invoked us to not continue (and thus not
481 ;; expand twice.) This means that any abbrev expansion
482 ;; will happen as a result of this function's call to
483 ;; expand-abbrev, and not as a result of the call to
484 ;; expand-abbrev which invoked *us*.
485 ;; - Then we set the syntax table to
486 ;; mail-mode-header-syntax-table, which doesn't have
487 ;; anything to do with abbrev expansion, but
488 ;; is just for the user's convenience (see its doc string.)
489 ;;
493 ;; If the character just typed was non-alpha-symbol-syntax,
494 ;; then don't expand the abbrev now (that is, don't expand
495 ;; when the user types -.) Check the character's syntax in
496 ;; the mail-mode-header-syntax-table.
502 ;; Use this table so that abbrevs can have hyphens in them.
505 ;; Now set it back to what it was before.
513 ;; We're not in a mail header where mail aliases should
514 ;; be expanded, then use the normal mail-mode abbrev table
515 ;; (if any) and the normal mail-mode syntax table.
518 mail-mode-abbrev-table))
520 ;; This is not a mail abbrev, and we should not expand it.
521 ;; This kludge stops expand-abbrev from doing anything.
524 ))
525 \f
526 ;;; utilities
529 "Merge mail aliases from the given file with existing ones."
536 def)
537 default-directory
539 t))))
543 "Rebuild all the mail aliases from the given file."
550 default-directory
552 t))))
559 "Prompt for and insert a mail alias."
568 "Perform completion on alias preceding point."
569 ;; Based on lisp.el:lisp-complete-symbol
596 "Expand any mail abbrev, then move cursor vertically down ARG lines.
597 If there is no character in the target line exactly under the current column,
598 the cursor is positioned after the character in that line which spans this
599 column, or at the end of the line if it is not long enough.
600 If there is no line in the buffer after this one,
601 a newline character is inserted to create a line
602 and the cursor moves to that line.
605 a semipermanent goal column to which this command always moves.
606 Then it does not try to move vertically. This goal column is stored
607 in `goal-column', which is nil when there is none.
609 If you are thinking of using this in a Lisp program, consider
610 using `forward-line' instead. It is usually easier to use
611 and more reliable (no dependence on goal column, etc.)."
618 "Expand any mail abbrev, then move point to end of buffer.
619 Leave mark at previous position.
620 With arg N, put point N/10 of the way from the true end.
622 Don't use this command in Lisp programs!
623 \(goto-char (point-max)) is faster and avoids clobbering the mark."
633 ;;(define-key mail-mode-map "\C-n" 'mail-abbrev-next-line)
634 ;;(define-key mail-mode-map "\M->" 'mail-abbrev-end-of-buffer)
641 ;;; mailabbrev.el ends here.