| blob | b4827cf10ba2ed717e5a24c2e19d240f1c306efe |
1 ;;; mailabbrev.el --- abbrev-expansion of mail aliases
3 ;; Copyright (C) 1985-1987, 1992-1993, 1996-1997, 2000-2011
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 3 of the License, or
16 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; This file ensures that, when the point is in a To:, CC:, BCC:, or From:
29 ;; field, word-abbrevs are defined for each of your mail aliases. These
30 ;; aliases will be defined from your .mailrc file (or the file specified by
31 ;; `mail-personal-alias-file') if it exists. Your mail aliases will
32 ;; expand any time you type a word-delimiter at the end of an abbreviation.
33 ;;
34 ;; What you see is what you get: if mailabbrev is in use when you type
35 ;; a name, and the name does not expand, you know it is not an abbreviation.
36 ;; However, if you yank abbreviations into the headers
37 ;; in a way that bypasses the check for abbreviations,
38 ;; they are expanded (but not visibly) when you send the message.
39 ;;
40 ;; Your mail alias abbrevs will be in effect only when the point is in an
41 ;; appropriate header field. When in the body of the message, or other
42 ;; header fields, the mail aliases will not expand. Rather, the normal
43 ;; mode-specific abbrev table will be used if
44 ;; defined. So if you use mail-mode specific abbrevs, this code will not
45 ;; adversely affect you. You can control which header fields the abbrevs
46 ;; are used in by changing the variable mail-abbrev-mode-regexp.
47 ;;
48 ;; If auto-fill mode is on, abbrevs will wrap at commas instead of at word
49 ;; boundaries; also, header continuation-lines will be properly indented.
50 ;;
51 ;; You can also insert a mail alias with mail-abbrev-insert-alias
52 ;; (bound to C-c C-a), which prompts you for an alias (with completion)
53 ;; and inserts its expansion at point.
54 ;;
55 ;; This file fixes a bug in the old system which prohibited your .mailrc
56 ;; file from having lines like
57 ;;
58 ;; alias someone "John Doe <doe@quux.com>"
59 ;;
60 ;; That is, if you want an address to have embedded spaces, simply surround it
61 ;; with double-quotes. This is necessary because the format of the .mailrc
62 ;; file bogusly uses spaces as address delimiters. The following line defines
63 ;; an alias which expands to three addresses:
64 ;;
65 ;; alias foobar addr-1 addr-2 "address three <addr-3>"
66 ;;
67 ;; (This is bogus because mail-delivery programs want commas, not spaces,
68 ;; but that's what the file format is, so we have to live with it.)
69 ;;
70 ;; If you like, you can call the function define-mail-abbrev to define your
71 ;; mail aliases instead of using a .mailrc file. When you call it in this
72 ;; way, addresses are separated by commas.
73 ;;
74 ;; CAVEAT: This works on most Sun systems; I have been told that some versions
75 ;; of /bin/mail do not understand double-quotes in the .mailrc file. So you
76 ;; should make sure your version does before including verbose addresses like
77 ;; this. One solution to this, if you are on a system whose /bin/mail doesn't
78 ;; work that way, (and you still want to be able to /bin/mail to send mail in
79 ;; addition to emacs) is to define minimal aliases (without full names) in
80 ;; your .mailrc file, and use define-mail-abbrev to redefine them when sending
81 ;; mail from emacs; this way, mail sent from /bin/mail will work, and mail
82 ;; sent from emacs will be pretty.
83 ;;
84 ;; Aliases in the mailrc file may be nested. If you define aliases like
85 ;; alias group1 fred ethel
86 ;; alias group2 larry curly moe
87 ;; alias everybody group1 group2
88 ;; Then when you type "everybody" on the To: line, it will be expanded to
89 ;; fred, ethyl, larry, curly, moe
90 ;;
91 ;; Aliases may also contain forward references; the alias of "everybody" can
92 ;; precede the aliases of "group1" and "group2".
93 ;;
94 ;; This code also understands the "source" .mailrc command, for reading
95 ;; aliases from some other file as well.
96 ;;
97 ;; Aliases may contain hyphens, as in "alias foo-bar foo@bar"; word-abbrevs
98 ;; normally cannot contain hyphens, but this code works around that for the
99 ;; specific case of mail-alias word-abbrevs.
100 ;;
101 ;; To read in the contents of another .mailrc-type file from emacs, use the
102 ;; command Meta-X merge-mail-abbrevs. The rebuild-mail-abbrevs command is
103 ;; similar, but will delete existing aliases first.
104 ;;
105 ;; If you would like your aliases to be expanded when you type M-> or ^N to
106 ;; move out of the mail-header into the message body (instead of having to
107 ;; type SPC at the end of the abbrev before moving away) then you can do
108 ;;
109 ;; (add-hook
110 ;; 'mail-mode-hook
111 ;; (lambda ()
112 ;; (define-key mail-mode-map [remap next-line] 'mail-abbrev-next-line)
113 ;; (define-key mail-mode-map [remap end-of-buffer] 'mail-abbrev-end-of-buffer)))
114 ;;
115 ;; If you want multiple addresses separated by a string other than ", " then
116 ;; you can set the variable mail-alias-separator-string to it. This has to
117 ;; be a comma bracketed by whitespace if you want any kind of reasonable
118 ;; behavior.
119 ;;
120 ;; Thanks to Harald Hanche-Olsen, Michael Ernst, David Loeffler, and
121 ;; Noah Friedman for suggestions and bug reports.
123 ;; To use this package, do (add-hook 'mail-mode-hook 'mail-abbrevs-setup).
125 ;;; Code:
131 "Expand mail aliases as abbrevs, in certain mail headers."
134 ;;;###autoload
136 "Non-nil means expand mail aliases as abbrevs, in certain message headers."
137 :global t
143 "Non-nil means only mail abbrevs should expand automatically.
144 Other abbrevs expand only when you explicitly use `expand-abbrev'."
148 ;; originally defined in sendmail.el - used to be an alist, now is a table.
150 "Word-abbrev table of mail address aliases.
151 If this is nil, it means the aliases have not yet been initialized and
152 should be read from the .mailrc file. (This is distinct from there being
167 ;;;###autoload
169 "Initialize use of the `mailabbrev' package."
184 "Turn off use of the `mailabbrev' package."
188 ;;;###autoload
190 "Read mail aliases from personal mail alias file and set `mail-abbrevs'.
191 By default this is the file specified by `mail-personal-alias-file'."
194 nil
205 ;; Don't lose if no final newline.
209 ;; Delete comments from the file
215 ;; handle "\\\n" continuation lines
231 t))
237 ;; (message "** %s \"%s\"" name (buffer-substring start (point)))(sit-for 1)
239 name
241 t))))
242 ;; Resolve forward references in .mailrc file.
243 ;; This would happen automatically before the first abbrev was
244 ;; expanded, but why not do it now.
246 mail-abbrevs)
250 "*A string inserted between addresses in multi-address mail aliases.
254 ;; define-mail-abbrev sets this flag, which causes mail-resolve-all-aliases
255 ;; to be called before expanding abbrevs if it's necessary.
258 ;; originally defined in mailalias.el ; build-mail-abbrevs calls this with
259 ;; stuff parsed from the .mailrc file.
260 ;;
261 ;;;###autoload
263 "Define NAME as a mail alias abbrev that translates to DEFINITION.
264 If DEFINITION contains multiple addresses, separate them with commas.
266 Optional argument FROM-MAILRC-FILE means that DEFINITION comes
267 from a mailrc file. In that case, addresses are separated with
268 spaces and addresses with embedded spaces are surrounded by
269 double-quotes."
270 ;; When this is called from build-mail-abbrevs, the third argument is
271 ;; true, and we do some evil space->comma hacking like /bin/mail does.
273 ;; Read the defaults first, if we have not done so.
275 ;; strip garbage from front and end
282 end this-entry result)
286 ;; If we're reading from the mailrc file, addresses are
287 ;; delimited by spaces, and addresses with embedded spaces are
288 ;; surrounded by non-escaped double-quotes.
293 definition start)
296 ;; Extract the address and advance the loop past it.
299 ;; If the full name contains a problem character, quote it.
306 this-entry)))
308 ;; When we are not reading from .mailrc, addresses are
309 ;; separated by commas. Try to accept a rfc822-like syntax.
310 ;; (Todo: extend rfc822.el to do the work for us.)
314 definition start)
315 start)
316 ;; If an entry has a valid [ "foo bar" <foo@example.com> ]
317 ;; form, use it literally . This also allows commas in the
318 ;; quoted string, e.g. [ "foo bar, jr" <foo@example.com> ]
322 ;; Otherwise, read the next address by looking for a comma.
325 ;; Advance the loop past this address.
327 ;; If the full name contains a problem character, quote it.
333 this-entry)))
338 mail-alias-separator-string)))
341 ;; use an abbrev table instead of an alist for mail-abbrevs.
347 "Resolve all forward references in the mail aliases table."
350 ;; (message "Resolving mail aliases...")
354 ;; (message "Resolving mail aliases... done.")
355 )))
374 x)))
376 mail-alias-separator-string))
382 "For use as the fourth arg to `define-abbrev'.
383 After expanding a mail-abbrev, if Auto Fill mode is on and we're past the
384 fill-column, break the line at the previous comma, and indent the next line."
385 ;; Disable abbrev mode to avoid recursion in indent-relative expanding
386 ;; part of the abbrev expansion as an abbrev itself.
390 bol comma fp)
404 ;; Go to the end of the new line.
407 ;; It's still too long; do normal auto-fill.
410 ;; Resume the search.
412 )))))
413 \f
414 ;;; Syntax tables and abbrev-expansion
418 "*Regexp to select mail-headers in which mail abbrevs should be expanded.
419 This string will be handed to `looking-at' with point at the beginning
420 of the current line; if it matches, abbrev mode will be turned on, otherwise
421 it will be turned off. (You don't need to worry about continuation lines.)
422 This should be set to match those mail fields in which you want abbreviations
426 "The syntax-table used for abbrev-expansion purposes.
427 This is not actually made the current syntax table of the buffer, but
428 simply controls the set of characters which may be a part of the name
440 ;; Fetch the inherited value
444 tab)
454 "Whether point is in a mail-address header field."
457 ;; we are on an appropriate header line...
461 ;; are we at the front of an appropriate header line?
463 ;;
464 ;; ...and are we in the headers?
476 ;; We are in a To: (or CC:, or whatever) header, and
477 ;; should use word-abbrevs to expand mail aliases.
480 ;; Before anything else, resolve aliases if they need it.
484 ;; Now proceed with the abbrev section.
485 ;; - We already installed mail-abbrevs as the abbrev table.
486 ;; - Then install the mail-abbrev-syntax-table, which
487 ;; temporarily marks all of the
488 ;; non-alphanumeric-atom-characters (the "_"
489 ;; syntax ones) as being normal word-syntax. We do this
490 ;; because the C code for expand-abbrev only works on words,
491 ;; and we want these characters to be considered words for
492 ;; the purpose of abbrev expansion.
493 ;; - Then we call the expand function, to do
494 ;; the abbrev expansion with the above syntax table.
498 ;; If the character just typed was non-alpha-symbol-syntax,
499 ;; then don't expand the abbrev now (that is, don't expand
500 ;; when the user types -.) Check the character's syntax in
501 ;; the usual syntax table.
504 ;; Some commands such as M-> may want to expand first.
507 ;; Don't expand on @.
509 ;; Use this table so that abbrevs can have hyphens in them.
515 ;; We're not in a mail header where mail aliases should
516 ;; be expanded, then use the normal mail-mode abbrev table
517 ;; (if any) and the normal mail-mode syntax table.
519 ;; This is not a mail abbrev, and we should not expand it.
520 ;; Don't expand anything.
521 nil))
522 ;; No mail-abbrevs at all, do the normal thing.
524 \f
525 ;;; utilities
528 "Merge mail aliases from the given file with existing ones."
535 def)
536 default-directory
538 t))))
542 "Rebuild all the mail aliases from the given file."
549 default-directory
551 t))))
558 "Prompt for and insert a mail alias."
567 "Perform completion on alias preceding point."
568 ;; Based on lisp.el:lisp-complete-symbol
579 "Expand a mail abbrev before point, then move vertically down ARG lines.
580 This only expands an abbrev (if one is present) if called with
581 point at the end of a line, or on whitespace before the end of a line.
583 In terms of line motion, this behaves like `next-line', which see."
590 "Expand a mail abbrev before point, then move to the end of the buffer.
591 This only expands an abbrev (if one is present) if called with
592 point at the end of a line, or on whitespace before the end of a line.
594 In other respects, this behaves like `end-of-buffer', which see."
606 ;;(define-key mail-mode-map "\C-n" 'mail-abbrev-next-line)
607 ;;(define-key mail-mode-map "\M->" 'mail-abbrev-end-of-buffer)
611 ;;; mailabbrev.el ends here