1 ;;; mail-utils.el --- utility functions used both by rmail and rnews
3 ;; Copyright (C) 1985 Free Software Foundation, Inc.
6 ;; Keywords: mail, news
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;; Utility functions for mail and netnews handling. These handle fine
28 ;; points of header parsing.
32 ;;; We require lisp-mode to make sure that lisp-mode-syntax-table has
37 (defcustom mail-use-rfc822 nil
"\
38 *If non-nil, use a full, hairy RFC822 parser on mail addresses.
39 Otherwise, (the default) use a smaller, somewhat faster, and
40 often correct parser."
44 ;; Returns t if file FILE is an Rmail file.
46 (defun mail-file-babyl-p (file)
47 (let ((buf (generate-new-buffer " *rmail-file-p*")))
51 (insert-file-contents file nil
0 100)
52 (looking-at "BABYL OPTIONS:"))
55 (defun mail-string-delete (string start end
)
56 "Returns a string containing all of STRING except the part
57 from START (inclusive) to END (exclusive)."
58 (if (null end
) (substring string
0 start
)
59 (concat (substring string
0 start
)
60 (substring string end nil
))))
63 (defun mail-quote-printable (string &optional wrapper
)
64 "Convert a string to the \"quoted printable\" Q encoding.
65 If the optional argument WRAPPER is non-nil,
66 we add the wrapper characters =?ISO-8859-1?Q?....?=."
67 (let ((i 0) (result ""))
69 (while (string-match "[?=\"\200-\377]" string i
)
71 (concat result
(substring string i
(match-beginning 0))
72 (upcase (format "=%02x"
73 (aref string
(match-beginning 0))))))
74 (setq i
(match-end 0)))
76 (concat "=?ISO-8859-1?Q?"
77 result
(substring string i
)
79 (concat result
(substring string i
))))))
81 (defun mail-unquote-printable-hexdigit (char)
87 (defun mail-unquote-printable (string &optional wrapper
)
88 "Undo the \"quoted printable\" encoding.
89 If the optional argument WRAPPER is non-nil,
90 we expect to find and remove the wrapper characters =?ISO-8859-1?Q?....?=."
93 (string-match "\\`=\\?ISO-8859-1\\?Q\\?\\([^?]*\\)\\?" string
)
94 (setq string
(match-string 1 string
)))
96 (while (string-match "=\\(..\\|\n\\)" string i
)
97 (setq strings
(cons (substring string i
(match-beginning 0)) strings
))
98 (unless (= (aref string
(match-beginning 1)) ?
\n)
101 (+ (* 16 (mail-unquote-printable-hexdigit
102 (aref string
(match-beginning 1))))
103 (mail-unquote-printable-hexdigit
104 (aref string
(1+ (match-beginning 1))))))
106 (setq i
(match-end 0)))
107 (apply 'concat
(nreverse (cons (substring string i
) strings
))))))
110 (defun mail-unquote-printable-region (beg end
&optional wrapper
)
111 "Undo the \"quoted printable\" encoding in buffer from BEG to END.
112 If the optional argument WRAPPER is non-nil,
113 we expect to find and remove the wrapper characters =?ISO-8859-1?Q?....?=."
118 (narrow-to-region beg end
)
119 (goto-char (point-min))
121 (looking-at "\\`=\\?ISO-8859-1\\?Q\\?\\([^?]*\\)\\?"))
122 (delete-region (match-end 1) end
)
123 (delete-region (point) (match-beginning 1)))
124 (while (re-search-forward "=\\(..\\|\n\\)" nil t
)
125 (goto-char (match-end 0))
127 (if (= (char-after (match-beginning 1)) ?
\n)
130 (+ (* 16 (mail-unquote-printable-hexdigit
131 (char-after (match-beginning 1))))
132 (mail-unquote-printable-hexdigit
133 (char-after (1+ (match-beginning 1)))))))
136 (defun mail-strip-quoted-names (address)
137 "Delete comments and quoted strings in an address list ADDRESS.
138 Also delete leading/trailing whitespace and replace FOO <BAR> with just BAR.
139 Return a modified address list."
143 (progn (require 'rfc822
)
144 (mapconcat 'identity
(rfc822-addresses address
) ", "))
147 ;; Detect nested comments.
148 (if (string-match "[ \t]*(\\([^)\\]\\|\\\\.\\|\\\\\n\\)*(" address
)
149 ;; Strip nested comments.
150 (with-current-buffer (get-buffer-create " *temp*")
153 (set-syntax-table lisp-mode-syntax-table
)
155 (while (search-forward "(" nil t
)
157 (skip-chars-backward " \t")
158 (delete-region (point)
162 (error (goto-char (point-max))))
164 (setq address
(buffer-string))
166 ;; Strip non-nested comments an easier way.
167 (while (setq pos
(string-match
168 ;; This doesn't hack rfc822 nested comments
169 ;; `(xyzzy (foo) whinge)' properly. Big deal.
170 "[ \t]*(\\([^)\\]\\|\\\\.\\|\\\\\n\\)*)"
172 (setq address
(replace-match "" nil nil address
0))))
174 ;; strip surrounding whitespace
175 (string-match "\\`[ \t\n]*" address
)
176 (setq address
(substring address
178 (string-match "[ \t\n]*\\'" address
181 ;; strip `quoted' names (This is supposed to hack `"Foo Bar" <bar@host>')
183 (while (setq pos
(string-match
184 "\\([ \t]?\\)\\([ \t]*\"\\([^\"\\]\\|\\\\.\\|\\\\\n\\)*\"[ \t\n]*\\)"
186 ;; If the next thing is "@", we have "foo bar"@host. Leave it.
187 (if (and (> (length address
) (match-end 0))
188 (= (aref address
(match-end 0)) ?
@))
189 (setq pos
(match-end 0))
190 ;; Otherwise discard the "..." part.
191 (setq address
(replace-match "" nil nil address
2))))
192 ;; If this address contains <...>, replace it with just
193 ;; the part between the <...>.
194 (while (setq pos
(string-match "\\(,\\s-*\\|\\`\\)\\([^,]*<\\([^>,:]*\\)>[^,]*\\)\\(\\s-*,\\|\\'\\)"
196 (setq address
(replace-match (match-string 3 address
)
200 ; rmail-dont-reply-to-names is defined in loaddefs
201 (defun rmail-dont-reply-to (userids)
202 "Returns string of mail addresses USERIDS sans any recipients
203 that start with matches for `rmail-dont-reply-to-names'.
204 Usenet paths ending in an element that matches are removed also."
205 (if (null rmail-dont-reply-to-names
)
206 (setq rmail-dont-reply-to-names
207 (concat (if rmail-default-dont-reply-to-names
208 (concat rmail-default-dont-reply-to-names
"\\|")
210 (concat (regexp-quote (user-login-name))
212 (let ((match (concat "\\(^\\|,\\)[ \t\n]*"
213 ;; Can anyone figure out what this is for?
214 ;; Is it an obsolete remnant of another way of
215 ;; handling Foo Bar <foo@machine>?
216 "\\([^,\n]*[!<]\\|\\)"
218 rmail-dont-reply-to-names
220 ;; Include the human name that precedes <foo@bar>.
221 "\\([^\,.<\"]\\|\"[^\"]*\"\\)*"
222 "<\\(" rmail-dont-reply-to-names
"\\)"
226 (while (setq pos
(string-match match userids pos
))
227 ;; If there's a match, it starts at the beginning of the string,
228 ;; or with `,'. We must delete from that position to the
229 ;; end of the user-id which starts at match-beginning 2.
230 (let (inside-quotes quote-pos last-quote-pos
)
232 (while (and (setq quote-pos
(string-match "\"" userids quote-pos
))
234 (setq last-quote-pos quote-pos
)
235 (setq quote-pos
(1+ quote-pos
))
236 (setq inside-quotes
(not inside-quotes
))))
238 (if (string-match "\"" userids pos
)
239 (setq pos
(string-match "\"" userids pos
))
240 ;; If the open-quote has no close-quote,
241 ;; delete the open-quote to get something well-defined.
242 ;; This case is not valid, but it can happen if things
243 ;; are weird elsewhere.
244 (setq userids
(replace-match "" nil nil userids
))
245 (setq userids
(concat (substring userids
0 last-quote-pos
)
246 (substring userids
(1+ last-quote-pos
))))
248 (setq userids
(replace-match "" nil nil userids
)))))
249 ;; get rid of any trailing commas
250 (if (setq pos
(string-match "[ ,\t\n]*\\'" userids
))
251 (setq userids
(substring userids
0 pos
)))
252 ;; remove leading spaces. they bother me.
253 (if (string-match "\\(\\s \\|,\\)*" userids
)
254 (substring userids
(match-end 0))
259 (defun mail-fetch-field (field-name &optional last all list
)
260 "Return the value of the header field whose type is FIELD-NAME.
261 The buffer is expected to be narrowed to just the header of the message.
262 If second arg LAST is non-nil, use the last field of type FIELD-NAME.
263 If third arg ALL is non-nil, concatenate all such fields with commas between.
264 If 4th arg LIST is non-nil, return a list of all such fields."
266 (goto-char (point-min))
267 (let ((case-fold-search t
)
268 (name (concat "^" (regexp-quote field-name
) "[ \t]*:[ \t]*")))
270 (let ((value (if all
"")))
271 (while (re-search-forward name nil t
)
272 (let ((opoint (point)))
273 (while (progn (forward-line 1)
274 (looking-at "[ \t]")))
275 ;; Back up over newline, then trailing spaces or tabs
277 (skip-chars-backward " \t" opoint
)
279 (setq value
(cons (buffer-substring-no-properties
282 (setq value
(concat value
283 (if (string= value
"") "" ", ")
284 (buffer-substring-no-properties
288 (and (not (string= value
"")) value
)))
289 (if (re-search-forward name nil t
)
291 (if last
(while (re-search-forward name nil t
)))
292 (let ((opoint (point)))
293 (while (progn (forward-line 1)
294 (looking-at "[ \t]")))
295 ;; Back up over newline, then trailing spaces or tabs
297 (skip-chars-backward " \t" opoint
)
298 (buffer-substring-no-properties opoint
(point)))))))))
300 ;; Parse a list of tokens separated by commas.
301 ;; It runs from point to the end of the visible part of the buffer.
302 ;; Whitespace before or after tokens is ignored,
303 ;; but whitespace within tokens is kept.
304 (defun mail-parse-comma-list ()
307 (skip-chars-forward " \t\n")
310 (skip-chars-forward "^,")
311 (skip-chars-backward " \t\n")
313 (cons (buffer-substring-no-properties beg
(point))
315 (skip-chars-forward "^,")
316 (skip-chars-forward ", \t\n"))
319 (defun mail-comma-list-regexp (labels)
321 (setq pos
(or (string-match "[^ \t]" labels
) 0))
322 ;; Remove leading and trailing whitespace.
323 (setq labels
(substring labels pos
(string-match "[ \t]*$" labels pos
)))
324 ;; Change each comma to \|, and flush surrounding whitespace.
325 (while (setq pos
(string-match "[ \t]*,[ \t]*" labels
))
327 (concat (substring labels
0 pos
)
329 (substring labels
(match-end 0))))))
332 (defun mail-rfc822-time-zone (time)
333 (let* ((sec (or (car (current-time-zone time
)) 0))
334 (absmin (/ (abs sec
) 60)))
335 (format "%c%02d%02d" (if (< sec
0) ?- ?
+) (/ absmin
60) (% absmin
60))))
337 (defun mail-rfc822-date ()
338 (let* ((time (current-time))
339 (s (current-time-string time
)))
340 (string-match "[^ ]+ +\\([^ ]+\\) +\\([^ ]+\\) \\([^ ]+\\) \\([^ ]+\\)" s
)
341 (concat (substring s
(match-beginning 2) (match-end 2)) " "
342 (substring s
(match-beginning 1) (match-end 1)) " "
343 (substring s
(match-beginning 4) (match-end 4)) " "
344 (substring s
(match-beginning 3) (match-end 3)) " "
345 (mail-rfc822-time-zone time
))))
347 (provide 'mail-utils
)
349 ;;; mail-utils.el ends here