1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
;;; mailheader.el --- mail header parsing, merging, formatting -*- lexical-binding: t; -*-
;; Copyright (C) 1996, 2001-2021 Free Software Foundation, Inc.
;; Author: Erik Naggum <erik@naggum.no>
;; Keywords: tools, mail, news
;; Package: mail-utils
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This package provides an abstraction of RFC 822 (or later) format, used in
;; mail, news, and some other systems. The simple syntactic rules for such
;; headers, such as quoting and line folding, are routinely reimplemented
;; in many individual packages. This package removes the need for this
;; redundancy by representing message headers as association lists,
;; offering functions to extract the set of headers from a message, to
;; parse individual headers, to merge sets of headers, and to format a set
;; of headers.
;; The car of each element in the message-header alist is a symbol whose
;; print name is the name of the header, in all lower-case. The cdr of an
;; element depends on the operation. After extracting headers from a
;; message, it is a string, the value of the header. An extracted set of
;; headers may be parsed further, which may turn it into a list, whose car
;; is the original value and whose subsequent elements depend on the
;; header. For formatting, it is evaluated to obtain the strings to be
;; inserted. For merging, one set of headers consists of strings, while
;; the other set will be evaluated with the symbols in the first set of
;; headers bound to their respective values.
;;; Code:
(defun mail-header-extract ()
"Extract headers from current buffer after point.
Returns a header alist, where each element is a cons cell (name . value),
where NAME is a symbol, and VALUE is the string value of the header having
that name."
(let ((message-headers ()) (top (point))
start end)
(while (and (setq start (point))
(> (skip-chars-forward "^\0- :") 0)
(= (following-char) ?:)
(setq end (point))
(progn (forward-char)
(> (skip-chars-forward " \t") 0)))
(let ((header (intern (downcase (buffer-substring start end))))
(value (list (buffer-substring
(point) (progn (end-of-line) (point))))))
(while (progn (forward-char) (> (skip-chars-forward " \t") 0))
(push (buffer-substring (point) (progn (end-of-line) (point)))
value))
(push (if (cdr value)
(cons header (mapconcat #'identity (nreverse value) " "))
(cons header (car value)))
message-headers)))
(goto-char top)
(nreverse message-headers)))
(defun mail-header-extract-no-properties ()
"Extract headers from current buffer after point, without properties.
Returns a header alist, where each element is a cons cell (name . value),
where NAME is a symbol, and VALUE is the string value of the header having
that name."
(mapcar
(lambda (elt)
(set-text-properties 0 (length (cdr elt)) nil (cdr elt))
elt)
(mail-header-extract)))
(defun mail-header-parse (parsing-rules headers)
"Apply PARSING-RULES to HEADERS.
PARSING-RULES is an alist whose keys are header names (symbols) and whose
value is a parsing function. The function takes one argument, a string,
and return a list of values, which will destructively replace the value
associated with the key in HEADERS, after being prepended with the original
value."
(dolist (rule parsing-rules)
(let ((header (assq (car rule) headers)))
(when header
(if (consp (cdr header))
(setf (cddr header) (funcall (cdr rule) (cadr header)))
(setf (cdr header)
(cons (cdr header) (funcall (cdr rule) (cdr header))))))))
headers)
;; Advertised part of the interface; see mail-header, mail-header-set.
(defun mail-header (header &optional header-alist)
"Return the value associated with header HEADER in HEADER-ALIST.
If the value is a string, it is the original value of the header. If the
value is a list, its first element is the original value of the header,
with any subsequent elements being the result of parsing the value."
(declare (gv-setter (lambda (value)
`(mail-header-set ,header ,value ,header-alist))))
(with-suppressed-warnings ((lexical headers)) (defvar headers))
(cdr (assq header (or header-alist headers))))
(defun mail-header-set (header value &optional header-alist)
"Set the value associated with header HEADER to VALUE in HEADER-ALIST.
HEADER-ALIST defaults to the dynamically bound variable `headers' if nil.
See `mail-header' for the semantics of VALUE."
(declare (obsolete alist-get "28.1"))
(with-suppressed-warnings ((lexical headers)) (defvar headers))
(let* ((alist (or header-alist headers))
(entry (assq header alist)))
(if entry
(setf (cdr entry) value)
(nconc alist (list (cons header value)))))
value)
(defun mail-header-merge (merge-rules headers)
"Return a new header alist with MERGE-RULES applied to HEADERS.
MERGE-RULES is an alist whose keys are header names (symbols) and whose
values are forms to evaluate, the results of which are the new headers. It
should be a string or a list of string. The first element may be nil to
denote that the formatting functions must use the remaining elements, or
skip the header altogether if there are no other elements.
The macro `mail-header' can be used to access headers in HEADERS."
(declare (obsolete alist-get "28.1"))
(with-suppressed-warnings ((lexical headers)) (defvar headers))
(let ((headers headers))
(mapcar
(lambda (rule)
(cons (car rule) (eval (cdr rule) t)))
merge-rules)))
(defvar mail-header-format-function
(lambda (header value)
"Function to format headers without a specified formatting function."
(insert (capitalize (symbol-name header))
": "
(if (consp value) (car value) value)
"\n")))
(defun mail-header-format (format-rules headers)
"Use FORMAT-RULES to format HEADERS and insert into current buffer.
HEADERS should be an alist of the form (HEADER . VALUE),
where HEADER is a header field name (a symbol or a string),
and VALUE is the contents for that header field.
FORMAT-RULES is an alist of elements (HEADER . FUNCTION) Here HEADER
is a header field name (a symbol), and FUNCTION is how to format that
header field, if it appears in HEADERS. Each FUNCTION should take two
arguments: the header symbol, and the value of that header. The value
returned by FUNCTION is inserted in the buffer unless it is nil.
If the function for a header field is nil, or if no function is
specified for a particular header field, the default action is to
insert the value of the header, unless it is nil.
The headers are inserted in the order of the FORMAT-RULES.
A key of t in FORMAT-RULES represents any otherwise unmentioned headers.
A key of nil has as its value a list of defaulted headers to ignore."
(let ((ignore (append (cdr (assq nil format-rules))
(mapcar #'car format-rules))))
(dolist (rule format-rules)
(let* ((header (car rule))
(value (alist-get header headers)))
(if (stringp header)
(setq header (intern header)))
(cond ((null header) 'ignore)
((eq header t)
(dolist (defaulted headers)
(unless (memq (car defaulted) ignore)
(let* ((header (car defaulted))
(value (cdr defaulted)))
(funcall (or (cdr rule) mail-header-format-function)
header value)))))
(value
(funcall (or (cdr rule) mail-header-format-function)
header value)))))
(insert "\n")))
(provide 'mailheader)
;;; mailheader.el ends here
|
