| blob | a9ce8247a6be57149cf655da8e0d36b694dd4310 |
1 ;;; mailabbrev.el --- abbrev-expansion of mail aliases
3 ;; Copyright (C) 1985, 1986, 1987, 1992, 1993, 1996, 1997, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5 ;; Free Software Foundation, Inc.
7 ;; Author: Jamie Zawinski <jwz@lucid.com; now jwz@jwz.org>
8 ;; Maintainer: FSF
9 ;; Created: 19 Oct 90
10 ;; Keywords: mail
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; This file ensures that, when the point is in a To:, CC:, BCC:, or From:
30 ;; field, word-abbrevs are defined for each of your mail aliases. These
31 ;; aliases will be defined from your .mailrc file (or the file specified by
32 ;; `mail-personal-alias-file') if it exists. Your mail aliases will
33 ;; expand any time you type a word-delimiter at the end of an abbreviation.
34 ;;
35 ;; What you see is what you get: if mailabbrev is in use when you type
36 ;; a name, and the name does not expand, you know it is not an abbreviation.
37 ;; However, if you yank abbreviations into the headers
38 ;; in a way that bypasses the check for abbreviations,
39 ;; they are expanded (but not visibly) when you send the message.
40 ;;
41 ;; Your mail alias abbrevs will be in effect only when the point is in an
42 ;; appropriate header field. When in the body of the message, or other
43 ;; header fields, the mail aliases will not expand. Rather, the normal
44 ;; mode-specific abbrev table will be used if
45 ;; defined. So if you use mail-mode specific abbrevs, this code will not
46 ;; adversely affect you. You can control which header fields the abbrevs
47 ;; are used in by changing the variable mail-abbrev-mode-regexp.
48 ;;
49 ;; If auto-fill mode is on, abbrevs will wrap at commas instead of at word
50 ;; boundaries; also, header continuation-lines will be properly indented.
51 ;;
52 ;; You can also insert a mail alias with mail-abbrev-insert-alias
53 ;; (bound to C-c C-a), which prompts you for an alias (with completion)
54 ;; and inserts its expansion at point.
55 ;;
56 ;; This file fixes a bug in the old system which prohibited your .mailrc
57 ;; file from having lines like
58 ;;
59 ;; alias someone "John Doe <doe@quux.com>"
60 ;;
61 ;; That is, if you want an address to have embedded spaces, simply surround it
62 ;; with double-quotes. This is necessary because the format of the .mailrc
63 ;; file bogusly uses spaces as address delimiters. The following line defines
64 ;; an alias which expands to three addresses:
65 ;;
66 ;; alias foobar addr-1 addr-2 "address three <addr-3>"
67 ;;
68 ;; (This is bogus because mail-delivery programs want commas, not spaces,
69 ;; but that's what the file format is, so we have to live with it.)
70 ;;
71 ;; If you like, you can call the function define-mail-abbrev to define your
72 ;; mail aliases instead of using a .mailrc file. When you call it in this
73 ;; way, addresses are separated by commas.
74 ;;
75 ;; CAVEAT: This works on most Sun systems; I have been told that some versions
76 ;; of /bin/mail do not understand double-quotes in the .mailrc file. So you
77 ;; should make sure your version does before including verbose addresses like
78 ;; this. One solution to this, if you are on a system whose /bin/mail doesn't
79 ;; work that way, (and you still want to be able to /bin/mail to send mail in
80 ;; addition to emacs) is to define minimal aliases (without full names) in
81 ;; your .mailrc file, and use define-mail-abbrev to redefine them when sending
82 ;; mail from emacs; this way, mail sent from /bin/mail will work, and mail
83 ;; sent from emacs will be pretty.
84 ;;
85 ;; Aliases in the mailrc file may be nested. If you define aliases like
86 ;; alias group1 fred ethel
87 ;; alias group2 larry curly moe
88 ;; alias everybody group1 group2
89 ;; Then when you type "everybody" on the To: line, it will be expanded to
90 ;; fred, ethyl, larry, curly, moe
91 ;;
92 ;; Aliases may also contain forward references; the alias of "everybody" can
93 ;; precede the aliases of "group1" and "group2".
94 ;;
95 ;; This code also understands the "source" .mailrc command, for reading
96 ;; aliases from some other file as well.
97 ;;
98 ;; Aliases may contain hyphens, as in "alias foo-bar foo@bar"; word-abbrevs
99 ;; normally cannot contain hyphens, but this code works around that for the
100 ;; specific case of mail-alias word-abbrevs.
101 ;;
102 ;; To read in the contents of another .mailrc-type file from emacs, use the
103 ;; command Meta-X merge-mail-abbrevs. The rebuild-mail-abbrevs command is
104 ;; similar, but will delete existing aliases first.
105 ;;
106 ;; If you would like your aliases to be expanded when you type M-> or ^N to
107 ;; move out of the mail-header into the message body (instead of having to
108 ;; type SPC at the end of the abbrev before moving away) then you can do
109 ;;
110 ;; (add-hook
111 ;; 'mail-mode-hook
112 ;; (lambda ()
113 ;; (define-key mail-mode-map [remap next-line] 'mail-abbrev-next-line)
114 ;; (define-key mail-mode-map [remap end-of-buffer] 'mail-abbrev-end-of-buffer)))
115 ;;
116 ;; If you want multiple addresses separated by a string other than ", " then
117 ;; you can set the variable mail-alias-separator-string to it. This has to
118 ;; be a comma bracketed by whitespace if you want any kind of reasonable
119 ;; behavior.
120 ;;
121 ;; Thanks to Harald Hanche-Olsen, Michael Ernst, David Loeffler, and
122 ;; Noah Friedman for suggestions and bug reports.
124 ;; To use this package, do (add-hook 'mail-mode-hook 'mail-abbrevs-setup).
126 ;;; Code:
132 "Expand mail aliases as abbrevs, in certain mail headers."
135 ;;;###autoload
137 "Non-nil means expand mail aliases as abbrevs, in certain message headers."
138 :global t
144 "Non-nil means only mail abbrevs should expand automatically.
145 Other abbrevs expand only when you explicitly use `expand-abbrev'."
149 ;; originally defined in sendmail.el - used to be an alist, now is a table.
151 "Word-abbrev table of mail address aliases.
152 If this is nil, it means the aliases have not yet been initialized and
153 should be read from the .mailrc file. (This is distinct from there being
168 ;;;###autoload
170 "Initialize use of the `mailabbrev' package."
185 "Turn off use of the `mailabbrev' package."
189 ;;;###autoload
191 "Read mail aliases from personal mail alias file and set `mail-abbrevs'.
192 By default this is the file specified by `mail-personal-alias-file'."
195 nil
206 ;; Don't lose if no final newline.
210 ;; Delete comments from the file
216 ;; handle "\\\n" continuation lines
232 t))
238 ;; (message "** %s \"%s\"" name (buffer-substring start (point)))(sit-for 1)
240 name
242 t))))
243 ;; Resolve forward references in .mailrc file.
244 ;; This would happen automatically before the first abbrev was
245 ;; expanded, but why not do it now.
247 mail-abbrevs)
251 "*A string inserted between addresses in multi-address mail aliases.
255 ;; define-mail-abbrev sets this flag, which causes mail-resolve-all-aliases
256 ;; to be called before expanding abbrevs if it's necessary.
259 ;; originally defined in mailalias.el ; build-mail-abbrevs calls this with
260 ;; stuff parsed from the .mailrc file.
261 ;;
262 ;;;###autoload
264 "Define NAME as a mail alias abbrev that translates to DEFINITION.
265 If DEFINITION contains multiple addresses, separate them with commas.
267 Optional argument FROM-MAILRC-FILE means that DEFINITION comes
268 from a mailrc file. In that case, addresses are separated with
269 spaces and addresses with embedded spaces are surrounded by
270 double-quotes."
271 ;; When this is called from build-mail-abbrevs, the third argument is
272 ;; true, and we do some evil space->comma hacking like /bin/mail does.
274 ;; Read the defaults first, if we have not done so.
276 ;; strip garbage from front and end
283 end this-entry result)
287 ;; If we're reading from the mailrc file, addresses are
288 ;; delimited by spaces, and addresses with embedded spaces are
289 ;; surrounded by non-escaped double-quotes.
294 definition start)
297 ;; Extract the address and advance the loop past it.
300 ;; If the full name contains a problem character, quote it.
307 this-entry)))
309 ;; When we are not reading from .mailrc, addresses are
310 ;; separated by commas. Try to accept a rfc822-like syntax.
311 ;; (Todo: extend rfc822.el to do the work for us.)
315 definition start)
316 start)
317 ;; If an entry has a valid [ "foo bar" <foo@example.com> ]
318 ;; form, use it literally . This also allows commas in the
319 ;; quoted string, e.g. [ "foo bar, jr" <foo@example.com> ]
323 ;; Otherwise, read the next address by looking for a comma.
326 ;; Advance the loop past this address.
328 ;; If the full name contains a problem character, quote it.
334 this-entry)))
339 mail-alias-separator-string)))
342 ;; use an abbrev table instead of an alist for mail-abbrevs.
348 "Resolve all forward references in the mail aliases table."
351 ;; (message "Resolving mail aliases...")
355 ;; (message "Resolving mail aliases... done.")
356 )))
375 x)))
377 mail-alias-separator-string))
383 "For use as the fourth arg to `define-abbrev'.
384 After expanding a mail-abbrev, if Auto Fill mode is on and we're past the
385 fill-column, break the line at the previous comma, and indent the next line."
386 ;; Disable abbrev mode to avoid recursion in indent-relative expanding
387 ;; part of the abbrev expansion as an abbrev itself.
391 bol comma fp)
405 ;; Go to the end of the new line.
408 ;; It's still too long; do normal auto-fill.
411 ;; Resume the search.
413 )))))
414 \f
415 ;;; Syntax tables and abbrev-expansion
419 "*Regexp to select mail-headers in which mail abbrevs should be expanded.
420 This string will be handed to `looking-at' with point at the beginning
421 of the current line; if it matches, abbrev mode will be turned on, otherwise
422 it will be turned off. (You don't need to worry about continuation lines.)
423 This should be set to match those mail fields in which you want abbreviations
427 "The syntax-table used for abbrev-expansion purposes.
428 This is not actually made the current syntax table of the buffer, but
429 simply controls the set of characters which may be a part of the name
441 ;; Fetch the inherited value
445 tab)
455 "Whether point is in a mail-address header field."
458 ;; we are on an appropriate header line...
462 ;; are we at the front of an appropriate header line?
464 ;;
465 ;; ...and are we in the headers?
477 ;; We are in a To: (or CC:, or whatever) header, and
478 ;; should use word-abbrevs to expand mail aliases.
481 ;; Before anything else, resolve aliases if they need it.
485 ;; Now proceed with the abbrev section.
486 ;; - We already installed mail-abbrevs as the abbrev table.
487 ;; - Then install the mail-abbrev-syntax-table, which
488 ;; temporarily marks all of the
489 ;; non-alphanumeric-atom-characters (the "_"
490 ;; syntax ones) as being normal word-syntax. We do this
491 ;; because the C code for expand-abbrev only works on words,
492 ;; and we want these characters to be considered words for
493 ;; the purpose of abbrev expansion.
494 ;; - Then we call the expand function, to do
495 ;; the abbrev expansion with the above syntax table.
499 ;; If the character just typed was non-alpha-symbol-syntax,
500 ;; then don't expand the abbrev now (that is, don't expand
501 ;; when the user types -.) Check the character's syntax in
502 ;; the usual syntax table.
505 ;; Some commands such as M-> may want to expand first.
508 ;; Don't expand on @.
510 ;; Use this table so that abbrevs can have hyphens in them.
516 ;; We're not in a mail header where mail aliases should
517 ;; be expanded, then use the normal mail-mode abbrev table
518 ;; (if any) and the normal mail-mode syntax table.
520 ;; This is not a mail abbrev, and we should not expand it.
521 ;; Don't expand anything.
522 nil))
523 ;; No mail-abbrevs at all, do the normal thing.
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
580 "Expand a mail abbrev before point, then move vertically down ARG lines.
581 This only expands an abbrev (if one is present) if called with
582 point at the end of a line, or on whitespace before the end of a line.
584 In terms of line motion, this behaves like `next-line', which see."
591 "Expand a mail abbrev before point, then move to the end of the buffer.
592 This only expands an abbrev (if one is present) if called with
593 point at the end of a line, or on whitespace before the end of a line.
595 In other respects, this behaves like `end-of-buffer', which see."
607 ;;(define-key mail-mode-map "\C-n" 'mail-abbrev-next-line)
608 ;;(define-key mail-mode-map "\M->" 'mail-abbrev-end-of-buffer)
612 ;;; mailabbrev.el ends here