(rmail-use-spam-filter): Add autoload cookie.
[bpt/emacs.git] / lisp / mail / rfc822.el
CommitLineData
c88ab9ce
ER
1;;; rfc822.el --- hairy rfc822 parser for mail and news and suchlike
2
9750e079
ER
3;; Copyright (C) 1986, 87, 1990 Free Software Foundation, Inc.
4
4821e2af
ER
5;; Author: Richard Mlynarik <mly@eddie.mit.edu>
6;; Maintainer: FSF
d7b4d18f 7;; Keywords: mail
4821e2af 8
cedaf3aa
RS
9;; This file is part of GNU Emacs.
10
11;; GNU Emacs is free software; you can redistribute it and/or modify
12;; it under the terms of the GNU General Public License as published by
29add8b9 13;; the Free Software Foundation; either version 2, or (at your option)
cedaf3aa
RS
14;; any later version.
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
b578f267
EN
22;; along with GNU Emacs; see the file COPYING. If not, write to the
23;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24;; Boston, MA 02111-1307, USA.
cedaf3aa 25
d9ecc911
ER
26;;; Commentary:
27
28;; Support functions for parsing RFC-822 headers, used by mail and news
a1506d29 29;; modes.
d9ecc911 30
4821e2af
ER
31;;; Code:
32
d6b4d749
RS
33(defvar rfc822-address-start)
34
35;; uses rfc822-address-start free, throws to address
cedaf3aa
RS
36(defun rfc822-bad-address (reason)
37 (save-restriction
38 (insert "_^_")
d6b4d749 39 (narrow-to-region rfc822-address-start
cedaf3aa
RS
40 (if (re-search-forward "[,;]" nil t)
41 (max (point-min) (1- (point)))
42 (point-max)))
43 ;; make the error string be suitable for inclusion in (...)
44 (let ((losers '("\\" "(" ")" "\n")))
45 (while losers
46 (goto-char (point-min))
47 (while (search-forward (car losers) nil t)
48 (backward-char 1)
49 (insert ?\\)
50 (forward-char 1))
51 (setq losers (cdr losers))))
52 (goto-char (point-min)) (insert "(Unparsable address -- "
53 reason
416916d4 54 ": \"")
cedaf3aa
RS
55 (goto-char (point-max)) (insert "\")"))
56 (rfc822-nuke-whitespace)
d6b4d749 57 (throw 'address (buffer-substring rfc822-address-start (point))))
cedaf3aa
RS
58
59(defun rfc822-nuke-whitespace (&optional leave-space)
60 (let (ch)
61 (while (cond ((eobp)
62 nil)
63 ((= (setq ch (following-char)) ?\()
64 (forward-char 1)
65 (while (if (eobp)
66 (rfc822-bad-address "Unbalanced comment (...)")
67 (/= (setq ch (following-char)) ?\)))
68 (cond ((looking-at "[^()\\]+")
69 (replace-match ""))
70 ((= ch ?\()
71 (rfc822-nuke-whitespace))
72 ((< (point) (1- (point-max)))
73 (delete-char 2))
74 (t
75 (rfc822-bad-address "orphaned backslash"))))
76 ;; delete remaining "()"
77 (forward-char -1)
78 (delete-char 2)
79 t)
a8eb445b 80 ((memq ch '(?\ ?\t ?\n))
cedaf3aa
RS
81 (delete-region (point)
82 (progn (skip-chars-forward " \t\n") (point)))
83 t)
84 (t
85 nil)))
86 (or (not leave-space)
87 (eobp)
88 (bobp)
89 (= (preceding-char) ?\ )
90 (insert ?\ ))))
91
92(defun rfc822-looking-at (regex &optional leave-space)
93 (if (cond ((stringp regex)
94 (if (looking-at regex)
95 (progn (goto-char (match-end 0))
96 t)))
97 (t
98 (if (and (not (eobp))
99 (= (following-char) regex))
100 (progn (forward-char 1)
101 t))))
102 (let ((tem (match-data)))
103 (rfc822-nuke-whitespace leave-space)
f6b4e0f4 104 (set-match-data tem)
cedaf3aa
RS
105 t)))
106
107(defun rfc822-snarf-word ()
108 ;; word is atom | quoted-string
109 (cond ((= (following-char) ?\")
110 ;; quoted-string
111 (or (rfc822-looking-at "\"\\([^\"\\\n]\\|\\\\.\\|\\\\\n\\)*\"")
112 (rfc822-bad-address "Unterminated quoted string")))
55872f3e 113 ((rfc822-looking-at "[^][\000-\037 ()<>@,;:\\\".]+")
cedaf3aa
RS
114 ;; atom
115 )
116 (t
117 (rfc822-bad-address "Rubbish in address"))))
118
119(defun rfc822-snarf-words ()
120 (rfc822-snarf-word)
121 (while (rfc822-looking-at ?.)
122 (rfc822-snarf-word)))
123
124(defun rfc822-snarf-subdomain ()
125 ;; sub-domain is domain-ref | domain-literal
126 (cond ((= (following-char) ?\[)
127 ;; domain-ref
128 (or (rfc822-looking-at "\\[\\([^][\\\n]\\|\\\\.\\|\\\\\n\\)*\\]")
129 (rfc822-bad-address "Unterminated domain literal [...]")))
55872f3e 130 ((rfc822-looking-at "[^][\000-\037 ()<>@,;:\\\".]+")
cedaf3aa
RS
131 ;; domain-literal = atom
132 )
133 (t
134 (rfc822-bad-address "Rubbish in host/domain specification"))))
135
136(defun rfc822-snarf-domain ()
137 (rfc822-snarf-subdomain)
138 (while (rfc822-looking-at ?.)
139 (rfc822-snarf-subdomain)))
140
141(defun rfc822-snarf-frob-list (name separator terminator snarfer
142 &optional return)
143 (let ((first t)
144 (list ())
145 tem)
146 (while (cond ((eobp)
147 (rfc822-bad-address
148 (format "End of addresses in middle of %s" name)))
149 ((rfc822-looking-at terminator)
150 nil)
151 ((rfc822-looking-at separator)
152 ;; multiple separators are allowed and do nothing.
153 (while (rfc822-looking-at separator))
154 t)
155 (first
156 t)
157 (t
158 (rfc822-bad-address
159 (format "Gubbish in middle of %s" name))))
160 (setq tem (funcall snarfer)
161 first nil)
162 (and return tem
163 (setq list (if (listp tem)
164 (nconc (reverse tem) list)
165 (cons tem list)))))
166 (nreverse list)))
167
168;; return either an address (a string) or a list of addresses
169(defun rfc822-addresses-1 (&optional allow-groups)
170 ;; Looking for an rfc822 `address'
171 ;; Either a group (1*word ":" [#mailbox] ";")
172 ;; or a mailbox (addr-spec | 1*word route-addr)
173 ;; addr-spec is (local-part "@" domain)
174 ;; route-addr is ("<" [1#("@" domain) ":"] addr-spec ">")
175 ;; local-part is (word *("." word))
176 ;; word is (atom | quoted-string)
177 ;; quoted-string is ("\([^\"\\n]\|\\.\|\\\n\)")
178 ;; atom is [^\000-\037\177 ()<>@,;:\".[]]+
179 ;; domain is sub-domain *("." sub-domain)
180 ;; sub-domain is domain-ref | domain-literal
181 ;; domain-literal is "[" *(dtext | quoted-pair) "]"
182 ;; dtext is "[^][\\n"
183 ;; domain-ref is atom
d6b4d749 184 (let ((rfc822-address-start (point))
cedaf3aa
RS
185 (n 0))
186 (catch 'address
187 ;; optimize common cases:
188 ;; foo
189 ;; foo.bar@bar.zap
190 ;; followed by "\\'\\|,\\|([^()\\]*)\\'"
191 ;; other common cases are:
192 ;; foo bar <foo.bar@baz.zap>
193 ;; "foo bar" <foo.bar@baz.zap>
194 ;; those aren't hacked yet.
55872f3e 195 (if (and (rfc822-looking-at "[^][\000-\037 ()<>@,;:\\\"]+\\(\\|@[^][\000-\037 ()<>@,;:\\\"]+\\)" t)
cedaf3aa
RS
196 (progn (or (eobp)
197 (rfc822-looking-at ?,))))
198 (progn
199 ;; rfc822-looking-at may have inserted a space
200 (or (bobp) (/= (preceding-char) ?\ ) (delete-char -1))
201 ;; relying on the fact that rfc822-looking-at <char>
202 ;; doesn't mung match-data
d6b4d749
RS
203 (throw 'address (buffer-substring rfc822-address-start (match-end 0)))))
204 (goto-char rfc822-address-start)
cedaf3aa
RS
205 (while t
206 (cond ((and (= n 1) (rfc822-looking-at ?@))
207 ;; local-part@domain
208 (rfc822-snarf-domain)
209 (throw 'address
d6b4d749 210 (buffer-substring rfc822-address-start (point))))
cedaf3aa
RS
211 ((rfc822-looking-at ?:)
212 (cond ((not allow-groups)
213 (rfc822-bad-address "A group name may not appear here"))
214 ((= n 0)
215 (rfc822-bad-address "No name for :...; group")))
216 ;; group
217 (throw 'address
218 ;; return a list of addresses
219 (rfc822-snarf-frob-list ":...; group" ?\, ?\;
220 'rfc822-addresses-1 t)))
221 ((rfc822-looking-at ?<)
222 (let ((start (point))
223 (strip t))
224 (cond ((rfc822-looking-at ?>)
225 ;; empty path
226 ())
227 ((and (not (eobp)) (= (following-char) ?\@))
228 ;; <@foo.bar,@baz:quux@abcd.efg>
229 (rfc822-snarf-frob-list "<...> address" ?\, ?\:
230 (function (lambda ()
231 (if (rfc822-looking-at ?\@)
232 (rfc822-snarf-domain)
233 (rfc822-bad-address
234 "Gubbish in route-addr")))))
235 (rfc822-snarf-words)
236 (or (rfc822-looking-at ?@)
237 (rfc822-bad-address "Malformed <..@..> address"))
238 (rfc822-snarf-domain)
239 (setq strip nil))
240 ((progn (rfc822-snarf-words) (rfc822-looking-at ?@))
241 ; allow <foo> (losing unix seems to do this)
242 (rfc822-snarf-domain)))
243 (let ((end (point)))
244 (if (rfc822-looking-at ?\>)
245 (throw 'address
246 (buffer-substring (if strip start (1- start))
247 (if strip end (1+ end))))
248 (rfc822-bad-address "Unterminated <...> address")))))
55872f3e 249 ((looking-at "[^][\000-\037 ()<>@,;:\\.]")
cedaf3aa
RS
250 ;; this allows "." to be part of the words preceding
251 ;; an addr-spec, since many broken mailers output
252 ;; "Hern K. Herklemeyer III
253 ;; <yank@megadeath.dod.gods-own-country>"
278fc732 254 (let ((again t))
255 (while again
256 (or (= n 0) (bobp) (= (preceding-char) ?\ )
257 (insert ?\ ))
48aefb44 258 (rfc822-snarf-words)
278fc732 259 (setq n (1+ n))
260 (setq again (or (rfc822-looking-at ?.)
55872f3e 261 (looking-at "[^][\000-\037 ()<>@,;:\\.]"))))))
cedaf3aa
RS
262 ((= n 0)
263 (throw 'address nil))
264 ((= n 1) ; allow "foo" (losing unix seems to do this)
265 (throw 'address
d6b4d749 266 (buffer-substring rfc822-address-start (point))))
278fc732 267 ((> n 1)
268 (rfc822-bad-address "Missing comma between addresses or badly-formatted address"))
269 ((or (eobp) (= (following-char) ?,))
cedaf3aa
RS
270 (rfc822-bad-address "Missing comma or route-spec"))
271 (t
272 (rfc822-bad-address "Strange character or missing comma")))))))
273
a1506d29 274
cedaf3aa 275(defun rfc822-addresses (header-text)
55872f3e 276 (if (string-match "\\`[ \t]*\\([^][\000-\037 ()<>@,;:\\\".]+\\)[ \t]*\\'"
cedaf3aa
RS
277 header-text)
278 ;; Make very simple case moderately fast.
279 (list (substring header-text (match-beginning 1) (match-end 1)))
280 (let ((buf (generate-new-buffer " rfc822")))
281 (unwind-protect
282 (save-excursion
283 (set-buffer buf)
284 (make-local-variable 'case-fold-search)
285 (setq case-fold-search nil) ;For speed(?)
286 (insert header-text)
287 ;; unfold continuation lines
288 (goto-char (point-min))
289
290 (while (re-search-forward "\\([^\\]\\(\\\\\\\\\\)*\\)\n[ \t]" nil t)
291 (replace-match "\\1 " t))
292
293 (goto-char (point-min))
cedaf3aa
RS
294 (let ((list ())
295 tem
d6b4d749
RS
296 rfc822-address-start); this is for rfc822-bad-address
297 (rfc822-nuke-whitespace)
cedaf3aa 298 (while (not (eobp))
d6b4d749 299 (setq rfc822-address-start (point))
cedaf3aa
RS
300 (setq tem
301 (catch 'address ; this is for rfc822-bad-address
302 (cond ((rfc822-looking-at ?\,)
303 nil)
55872f3e 304 ((looking-at "[][\000-\037@;:\\.>)]")
cedaf3aa
RS
305 (forward-char)
306 (rfc822-bad-address
307 (format "Strange character \\%c found"
308 (preceding-char))))
309 (t
310 (rfc822-addresses-1 t)))))
311 (cond ((null tem))
312 ((stringp tem)
313 (setq list (cons tem list)))
314 (t
315 (setq list (nconc (nreverse tem) list)))))
316 (nreverse list)))
317 (and buf (kill-buffer buf))))))
318
49116ac0
JB
319(provide 'rfc822)
320
ab5796a9 321;;; arch-tag: 5d388a24-e173-40fb-9b8e-85269de44b37
c88ab9ce 322;;; rfc822.el ends here