Mercurial > emacs
annotate doc/misc/emacs-mime.texi @ 104078:2658bfb08516
Better docstring for `called-interactively-p'.
author | Bastien Guerry <bzg@altern.org> |
---|---|
date | Mon, 27 Jul 2009 02:02:49 +0000 |
parents | 9bcea07061a8 |
children | b99b3dda298b |
rev | line source |
---|---|
84292 | 1 \input texinfo |
2 | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84292
diff
changeset
|
3 @setfilename ../../info/emacs-mime |
84292 | 4 @settitle Emacs MIME Manual |
5 @synindex fn cp | |
6 @synindex vr cp | |
7 @synindex pg cp | |
8 | |
9 @copying | |
10 This file documents the Emacs MIME interface functionality. | |
11 | |
12 Copyright @copyright{} 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, | |
100974 | 13 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
84292 | 14 |
15 @quotation | |
16 Permission is granted to copy, distribute and/or modify this document | |
99709
6de181810d0f
Relicense all texi files under FDL 1.3 or later.
Glenn Morris <rgm@gnu.org>
parents:
95937
diff
changeset
|
17 under the terms of the GNU Free Documentation License, Version 1.3 or |
84292 | 18 any later version published by the Free Software Foundation; with no |
95937
6f0fce2c3559
Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
19 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', |
6f0fce2c3559
Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
20 and with the Back-Cover Texts as in (a) below. A copy of the license |
6f0fce2c3559
Remove references to external license, since doclicense is included.
Glenn Morris <rgm@gnu.org>
parents:
95874
diff
changeset
|
21 is included in the section entitled ``GNU Free Documentation License''. |
84292 | 22 |
95874
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
23 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
24 modify this GNU manual. Buying copies from the FSF supports it in |
eafbd7a5c9be
Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents:
87903
diff
changeset
|
25 developing GNU and promoting software freedom.'' |
84292 | 26 @end quotation |
27 @end copying | |
28 | |
29 @c Node ``Interface Functions'' uses Latin-1 characters | |
30 @documentencoding ISO-8859-1 | |
31 | |
32 @dircategory Emacs | |
33 @direntry | |
34 * Emacs MIME: (emacs-mime). Emacs MIME de/composition library. | |
35 @end direntry | |
36 @iftex | |
37 @finalout | |
38 @end iftex | |
39 @setchapternewpage odd | |
40 | |
41 @titlepage | |
42 @title Emacs MIME Manual | |
43 | |
44 @author by Lars Magne Ingebrigtsen | |
45 @page | |
46 @vskip 0pt plus 1filll | |
47 @insertcopying | |
48 @end titlepage | |
49 | |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
100974
diff
changeset
|
50 @contents |
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
100974
diff
changeset
|
51 |
84292 | 52 @node Top |
53 @top Emacs MIME | |
54 | |
55 This manual documents the libraries used to compose and display | |
56 @acronym{MIME} messages. | |
57 | |
58 This manual is directed at users who want to modify the behavior of | |
59 the @acronym{MIME} encoding/decoding process or want a more detailed | |
60 picture of how the Emacs @acronym{MIME} library works, and people who want | |
61 to write functions and commands that manipulate @acronym{MIME} elements. | |
62 | |
63 @acronym{MIME} is short for @dfn{Multipurpose Internet Mail Extensions}. | |
64 This standard is documented in a number of RFCs; mainly RFC2045 (Format | |
65 of Internet Message Bodies), RFC2046 (Media Types), RFC2047 (Message | |
66 Header Extensions for Non-@acronym{ASCII} Text), RFC2048 (Registration | |
67 Procedures), RFC2049 (Conformance Criteria and Examples). It is highly | |
68 recommended that anyone who intends writing @acronym{MIME}-compliant software | |
69 read at least RFC2045 and RFC2047. | |
70 | |
102059
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
100974
diff
changeset
|
71 @ifnottex |
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
100974
diff
changeset
|
72 @insertcopying |
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
100974
diff
changeset
|
73 @end ifnottex |
9bcea07061a8
consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents:
100974
diff
changeset
|
74 |
84292 | 75 @menu |
76 * Decoding and Viewing:: A framework for decoding and viewing. | |
77 * Composing:: @acronym{MML}; a language for describing @acronym{MIME} parts. | |
78 * Interface Functions:: An abstraction over the basic functions. | |
79 * Basic Functions:: Utility and basic parsing functions. | |
80 * Standards:: A summary of RFCs and working documents used. | |
81 * GNU Free Documentation License:: The license for this documentation. | |
82 * Index:: Function and variable index. | |
83 @end menu | |
84 | |
85 | |
86 @node Decoding and Viewing | |
87 @chapter Decoding and Viewing | |
88 | |
89 This chapter deals with decoding and viewing @acronym{MIME} messages on a | |
90 higher level. | |
91 | |
92 The main idea is to first analyze a @acronym{MIME} article, and then allow | |
93 other programs to do things based on the list of @dfn{handles} that are | |
94 returned as a result of this analysis. | |
95 | |
96 @menu | |
97 * Dissection:: Analyzing a @acronym{MIME} message. | |
98 * Non-MIME:: Analyzing a non-@acronym{MIME} message. | |
99 * Handles:: Handle manipulations. | |
100 * Display:: Displaying handles. | |
101 * Display Customization:: Variables that affect display. | |
102 * Files and Directories:: Saving and naming attachments. | |
103 * New Viewers:: How to write your own viewers. | |
104 @end menu | |
105 | |
106 | |
107 @node Dissection | |
108 @section Dissection | |
109 | |
110 The @code{mm-dissect-buffer} is the function responsible for dissecting | |
111 a @acronym{MIME} article. If given a multipart message, it will recursively | |
112 descend the message, following the structure, and return a tree of | |
113 @acronym{MIME} handles that describes the structure of the message. | |
114 | |
115 @node Non-MIME | |
116 @section Non-MIME | |
117 @vindex mm-uu-configure-list | |
118 | |
119 Gnus also understands some non-@acronym{MIME} attachments, such as | |
120 postscript, uuencode, binhex, yenc, shar, forward, gnatsweb, pgp, | |
121 diff. Each of these features can be disabled by add an item into | |
122 @code{mm-uu-configure-list}. For example, | |
123 | |
124 @lisp | |
125 (require 'mm-uu) | |
126 (add-to-list 'mm-uu-configure-list '(pgp-signed . disabled)) | |
127 @end lisp | |
128 | |
129 @table @code | |
130 @item postscript | |
131 @findex postscript | |
132 PostScript file. | |
133 | |
134 @item uu | |
135 @findex uu | |
136 Uuencoded file. | |
137 | |
138 @item binhex | |
139 @findex binhex | |
140 Binhex encoded file. | |
141 | |
142 @item yenc | |
143 @findex yenc | |
144 Yenc encoded file. | |
145 | |
146 @item shar | |
147 @findex shar | |
148 Shar archive file. | |
149 | |
150 @item forward | |
151 @findex forward | |
152 Non-@acronym{MIME} forwarded message. | |
153 | |
154 @item gnatsweb | |
155 @findex gnatsweb | |
156 Gnatsweb attachment. | |
157 | |
158 @item pgp-signed | |
159 @findex pgp-signed | |
160 @acronym{PGP} signed clear text. | |
161 | |
162 @item pgp-encrypted | |
163 @findex pgp-encrypted | |
164 @acronym{PGP} encrypted clear text. | |
165 | |
166 @item pgp-key | |
167 @findex pgp-key | |
168 @acronym{PGP} public keys. | |
169 | |
170 @item emacs-sources | |
171 @findex emacs-sources | |
172 @vindex mm-uu-emacs-sources-regexp | |
173 Emacs source code. This item works only in the groups matching | |
174 @code{mm-uu-emacs-sources-regexp}. | |
175 | |
176 @item diff | |
177 @vindex diff | |
178 @vindex mm-uu-diff-groups-regexp | |
179 Patches. This is intended for groups where diffs of committed files | |
180 are automatically sent to. It only works in groups matching | |
181 @code{mm-uu-diff-groups-regexp}. | |
182 | |
85712
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
183 @item verbatim-marks |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
184 @cindex verbatim-marks |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
185 Slrn-style verbatim marks. |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
186 |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
187 @item LaTeX |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
188 @cindex LaTeX |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
189 LaTeX documents. It only works in groups matching |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
190 @code{mm-uu-tex-groups-regexp}. |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
191 |
84292 | 192 @end table |
193 | |
85712
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
194 @cindex text/x-verbatim |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
195 @c Is @vindex suitable for a face? |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
196 @vindex mm-uu-extract |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
197 Some inlined non-@acronym{MIME} attachments are displayed using the face |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
198 @code{mm-uu-extract}. By default, no @acronym{MIME} button for these |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
199 parts is displayed. You can force displaying a button using @kbd{K b} |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
200 (@code{gnus-summary-display-buttonized}) or add @code{text/x-verbatim} |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
201 to @code{gnus-buttonized-mime-types}, @xref{MIME Commands, ,MIME |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
202 Commands, gnus, Gnus Manual}. |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
203 |
84292 | 204 @node Handles |
205 @section Handles | |
206 | |
207 A @acronym{MIME} handle is a list that fully describes a @acronym{MIME} | |
208 component. | |
209 | |
210 The following macros can be used to access elements in a handle: | |
211 | |
212 @table @code | |
213 @item mm-handle-buffer | |
214 @findex mm-handle-buffer | |
215 Return the buffer that holds the contents of the undecoded @acronym{MIME} | |
216 part. | |
217 | |
218 @item mm-handle-type | |
219 @findex mm-handle-type | |
220 Return the parsed @code{Content-Type} of the part. | |
221 | |
222 @item mm-handle-encoding | |
223 @findex mm-handle-encoding | |
224 Return the @code{Content-Transfer-Encoding} of the part. | |
225 | |
226 @item mm-handle-undisplayer | |
227 @findex mm-handle-undisplayer | |
228 Return the object that can be used to remove the displayed part (if it | |
229 has been displayed). | |
230 | |
231 @item mm-handle-set-undisplayer | |
232 @findex mm-handle-set-undisplayer | |
233 Set the undisplayer object. | |
234 | |
235 @item mm-handle-disposition | |
236 @findex mm-handle-disposition | |
237 Return the parsed @code{Content-Disposition} of the part. | |
238 | |
239 @item mm-get-content-id | |
240 Returns the handle(s) referred to by @code{Content-ID}. | |
241 | |
242 @end table | |
243 | |
244 | |
245 @node Display | |
246 @section Display | |
247 | |
248 Functions for displaying, removing and saving. | |
249 | |
250 @table @code | |
251 @item mm-display-part | |
252 @findex mm-display-part | |
253 Display the part. | |
254 | |
255 @item mm-remove-part | |
256 @findex mm-remove-part | |
257 Remove the part (if it has been displayed). | |
258 | |
259 @item mm-inlinable-p | |
260 @findex mm-inlinable-p | |
261 Say whether a @acronym{MIME} type can be displayed inline. | |
262 | |
263 @item mm-automatic-display-p | |
264 @findex mm-automatic-display-p | |
265 Say whether a @acronym{MIME} type should be displayed automatically. | |
266 | |
267 @item mm-destroy-part | |
268 @findex mm-destroy-part | |
269 Free all resources occupied by a part. | |
270 | |
271 @item mm-save-part | |
272 @findex mm-save-part | |
273 Offer to save the part in a file. | |
274 | |
275 @item mm-pipe-part | |
276 @findex mm-pipe-part | |
277 Offer to pipe the part to some process. | |
278 | |
279 @item mm-interactively-view-part | |
280 @findex mm-interactively-view-part | |
281 Prompt for a mailcap method to use to view the part. | |
282 | |
283 @end table | |
284 | |
285 | |
286 @node Display Customization | |
287 @section Display Customization | |
288 | |
289 @table @code | |
290 | |
291 @item mm-inline-media-tests | |
292 @vindex mm-inline-media-tests | |
293 This is an alist where the key is a @acronym{MIME} type, the second element | |
294 is a function to display the part @dfn{inline} (i.e., inside Emacs), and | |
295 the third element is a form to be @code{eval}ed to say whether the part | |
296 can be displayed inline. | |
297 | |
298 This variable specifies whether a part @emph{can} be displayed inline, | |
299 and, if so, how to do it. It does not say whether parts are | |
300 @emph{actually} displayed inline. | |
301 | |
302 @item mm-inlined-types | |
303 @vindex mm-inlined-types | |
304 This, on the other hand, says what types are to be displayed inline, if | |
305 they satisfy the conditions set by the variable above. It's a list of | |
306 @acronym{MIME} media types. | |
307 | |
308 @item mm-automatic-display | |
309 @vindex mm-automatic-display | |
310 This is a list of types that are to be displayed ``automatically'', but | |
311 only if the above variable allows it. That is, only inlinable parts can | |
312 be displayed automatically. | |
313 | |
314 @item mm-automatic-external-display | |
315 @vindex mm-automatic-external-display | |
316 This is a list of types that will be displayed automatically in an | |
317 external viewer. | |
318 | |
319 @item mm-keep-viewer-alive-types | |
320 @vindex mm-keep-viewer-alive-types | |
321 This is a list of media types for which the external viewer will not | |
322 be killed when selecting a different article. | |
323 | |
324 @item mm-attachment-override-types | |
325 @vindex mm-attachment-override-types | |
326 Some @acronym{MIME} agents create parts that have a content-disposition of | |
327 @samp{attachment}. This variable allows overriding that disposition and | |
328 displaying the part inline. (Note that the disposition is only | |
329 overridden if we are able to, and want to, display the part inline.) | |
330 | |
331 @item mm-discouraged-alternatives | |
332 @vindex mm-discouraged-alternatives | |
333 List of @acronym{MIME} types that are discouraged when viewing | |
334 @samp{multipart/alternative}. Viewing agents are supposed to view the | |
335 last possible part of a message, as that is supposed to be the richest. | |
336 However, users may prefer other types instead, and this list says what | |
337 types are most unwanted. If, for instance, @samp{text/html} parts are | |
338 very unwanted, and @samp{text/richtext} parts are somewhat unwanted, | |
339 you could say something like: | |
340 | |
341 @lisp | |
342 (setq mm-discouraged-alternatives | |
343 '("text/html" "text/richtext") | |
344 mm-automatic-display | |
345 (remove "text/html" mm-automatic-display)) | |
346 @end lisp | |
347 | |
348 Adding @code{"image/.*"} might also be useful. Spammers use images as | |
349 the preferred part of @samp{multipart/alternative} messages, so you might | |
350 not notice there are other parts. See also | |
351 @code{gnus-buttonized-mime-types}, @ref{MIME Commands, ,MIME Commands, | |
352 gnus, Gnus Manual}. After adding @code{"multipart/alternative"} to | |
353 @code{gnus-buttonized-mime-types} you can choose manually which | |
354 alternative you'd like to view. For example, you can set those | |
355 variables like: | |
356 | |
357 @lisp | |
358 (setq gnus-buttonized-mime-types | |
359 '("multipart/alternative" "multipart/signed") | |
360 mm-discouraged-alternatives | |
361 '("text/html" "image/.*")) | |
362 @end lisp | |
363 | |
364 In this case, Gnus will display radio buttons for such a kind of spam | |
365 message as follows: | |
366 | |
367 @example | |
368 1. (*) multipart/alternative ( ) image/gif | |
369 | |
370 2. (*) text/plain ( ) text/html | |
371 @end example | |
372 | |
373 @item mm-inline-large-images | |
374 @vindex mm-inline-large-images | |
375 When displaying inline images that are larger than the window, Emacs | |
376 does not enable scrolling, which means that you cannot see the whole | |
377 image. To prevent this, the library tries to determine the image size | |
378 before displaying it inline, and if it doesn't fit the window, the | |
379 library will display it externally (e.g. with @samp{ImageMagick} or | |
380 @samp{xv}). Setting this variable to @code{t} disables this check and | |
381 makes the library display all inline images as inline, regardless of | |
382 their size. | |
383 | |
384 @item mm-inline-override-types | |
385 @vindex mm-inline-override-types | |
386 @code{mm-inlined-types} may include regular expressions, for example to | |
387 specify that all @samp{text/.*} parts be displayed inline. If a user | |
388 prefers to have a type that matches such a regular expression be treated | |
389 as an attachment, that can be accomplished by setting this variable to a | |
390 list containing that type. For example assuming @code{mm-inlined-types} | |
391 includes @samp{text/.*}, then including @samp{text/html} in this | |
392 variable will cause @samp{text/html} parts to be treated as attachments. | |
393 | |
394 @item mm-text-html-renderer | |
395 @vindex mm-text-html-renderer | |
396 This selects the function used to render @acronym{HTML}. The predefined | |
397 renderers are selected by the symbols @code{w3}, | |
398 @code{w3m}@footnote{See @uref{http://emacs-w3m.namazu.org/} for more | |
399 information about emacs-w3m}, @code{links}, @code{lynx}, | |
400 @code{w3m-standalone} or @code{html2text}. If @code{nil} use an | |
401 external viewer. You can also specify a function, which will be | |
402 called with a @acronym{MIME} handle as the argument. | |
403 | |
404 @item mm-inline-text-html-with-images | |
405 @vindex mm-inline-text-html-with-images | |
406 Some @acronym{HTML} mails might have the trick of spammers using | |
407 @samp{<img>} tags. It is likely to be intended to verify whether you | |
408 have read the mail. You can prevent your personal informations from | |
409 leaking by setting this option to @code{nil} (which is the default). | |
410 It is currently ignored by Emacs/w3. For emacs-w3m, you may use the | |
411 command @kbd{t} on the image anchor to show an image even if it is | |
412 @code{nil}.@footnote{The command @kbd{T} will load all images. If you | |
413 have set the option @code{w3m-key-binding} to @code{info}, use @kbd{i} | |
414 or @kbd{I} instead.} | |
415 | |
416 @item mm-w3m-safe-url-regexp | |
417 @vindex mm-w3m-safe-url-regexp | |
418 A regular expression that matches safe URL names, i.e. URLs that are | |
419 unlikely to leak personal information when rendering @acronym{HTML} | |
420 email (the default value is @samp{\\`cid:}). If @code{nil} consider | |
421 all URLs safe. | |
422 | |
423 @item mm-inline-text-html-with-w3m-keymap | |
424 @vindex mm-inline-text-html-with-w3m-keymap | |
425 You can use emacs-w3m command keys in the inlined text/html part by | |
426 setting this option to non-@code{nil}. The default value is @code{t}. | |
427 | |
428 @item mm-external-terminal-program | |
429 @vindex mm-external-terminal-program | |
430 The program used to start an external terminal. | |
431 | |
432 @item mm-enable-external | |
433 @vindex mm-enable-external | |
434 Indicate whether external @acronym{MIME} handlers should be used. | |
435 | |
436 If @code{t}, all defined external @acronym{MIME} handlers are used. If | |
437 @code{nil}, files are saved to disk (@code{mailcap-save-binary-file}). | |
438 If it is the symbol @code{ask}, you are prompted before the external | |
439 @acronym{MIME} handler is invoked. | |
440 | |
441 When you launch an attachment through mailcap (@pxref{mailcap}) an | |
442 attempt is made to use a safe viewer with the safest options---this isn't | |
443 the case if you save it to disk and launch it in a different way | |
444 (command line or double-clicking). Anyhow, if you want to be sure not | |
445 to launch any external programs, set this variable to @code{nil} or | |
446 @code{ask}. | |
447 | |
448 @end table | |
449 | |
450 @node Files and Directories | |
451 @section Files and Directories | |
452 | |
453 @table @code | |
454 | |
455 @item mm-default-directory | |
456 @vindex mm-default-directory | |
457 The default directory for saving attachments. If @code{nil} use | |
458 @code{default-directory}. | |
459 | |
460 @item mm-tmp-directory | |
461 @vindex mm-tmp-directory | |
462 Directory for storing temporary files. | |
463 | |
464 @item mm-file-name-rewrite-functions | |
465 @vindex mm-file-name-rewrite-functions | |
466 A list of functions used for rewriting file names of @acronym{MIME} | |
467 parts. Each function is applied successively to the file name. | |
468 Ready-made functions include | |
469 | |
470 @table @code | |
471 @item mm-file-name-delete-control | |
472 @findex mm-file-name-delete-control | |
473 Delete all control characters. | |
474 | |
475 @item mm-file-name-delete-gotchas | |
476 @findex mm-file-name-delete-gotchas | |
477 Delete characters that could have unintended consequences when used | |
478 with flawed shell scripts, i.e. @samp{|}, @samp{>} and @samp{<}; and | |
479 @samp{-}, @samp{.} as the first character. | |
480 | |
481 @item mm-file-name-delete-whitespace | |
482 @findex mm-file-name-delete-whitespace | |
483 Remove all whitespace. | |
484 | |
485 @item mm-file-name-trim-whitespace | |
486 @findex mm-file-name-trim-whitespace | |
487 Remove leading and trailing whitespace. | |
488 | |
489 @item mm-file-name-collapse-whitespace | |
490 @findex mm-file-name-collapse-whitespace | |
491 Collapse multiple whitespace characters. | |
492 | |
493 @item mm-file-name-replace-whitespace | |
494 @findex mm-file-name-replace-whitespace | |
495 @vindex mm-file-name-replace-whitespace | |
496 Replace whitespace with underscores. Set the variable | |
497 @code{mm-file-name-replace-whitespace} to any other string if you do | |
498 not like underscores. | |
499 @end table | |
500 | |
501 The standard Emacs functions @code{capitalize}, @code{downcase}, | |
502 @code{upcase} and @code{upcase-initials} might also prove useful. | |
503 | |
504 @item mm-path-name-rewrite-functions | |
505 @vindex mm-path-name-rewrite-functions | |
506 List of functions used for rewriting the full file names of @acronym{MIME} | |
507 parts. This is used when viewing parts externally, and is meant for | |
508 transforming the absolute name so that non-compliant programs can find | |
509 the file where it's saved. | |
510 | |
511 @end table | |
512 | |
513 @node New Viewers | |
514 @section New Viewers | |
515 | |
516 Here's an example viewer for displaying @code{text/enriched} inline: | |
517 | |
518 @lisp | |
519 (defun mm-display-enriched-inline (handle) | |
520 (let (text) | |
521 (with-temp-buffer | |
522 (mm-insert-part handle) | |
523 (save-window-excursion | |
524 (enriched-decode (point-min) (point-max)) | |
525 (setq text (buffer-string)))) | |
526 (mm-insert-inline handle text))) | |
527 @end lisp | |
528 | |
529 We see that the function takes a @acronym{MIME} handle as its parameter. It | |
530 then goes to a temporary buffer, inserts the text of the part, does some | |
531 work on the text, stores the result, goes back to the buffer it was | |
532 called from and inserts the result. | |
533 | |
534 The two important helper functions here are @code{mm-insert-part} and | |
535 @code{mm-insert-inline}. The first function inserts the text of the | |
536 handle in the current buffer. It handles charset and/or content | |
537 transfer decoding. The second function just inserts whatever text you | |
538 tell it to insert, but it also sets things up so that the text can be | |
539 ``undisplayed'' in a convenient manner. | |
540 | |
541 | |
542 @node Composing | |
543 @chapter Composing | |
544 @cindex Composing | |
545 @cindex MIME Composing | |
546 @cindex MML | |
547 @cindex MIME Meta Language | |
548 | |
549 Creating a @acronym{MIME} message is boring and non-trivial. Therefore, | |
550 a library called @code{mml} has been defined that parses a language | |
551 called @acronym{MML} (@acronym{MIME} Meta Language) and generates | |
552 @acronym{MIME} messages. | |
553 | |
554 @findex mml-generate-mime | |
555 The main interface function is @code{mml-generate-mime}. It will | |
556 examine the contents of the current (narrowed-to) buffer and return a | |
557 string containing the @acronym{MIME} message. | |
558 | |
559 @menu | |
560 * Simple MML Example:: An example @acronym{MML} document. | |
561 * MML Definition:: All valid @acronym{MML} elements. | |
562 * Advanced MML Example:: Another example @acronym{MML} document. | |
563 * Encoding Customization:: Variables that affect encoding. | |
564 * Charset Translation:: How charsets are mapped from @sc{mule} to @acronym{MIME}. | |
565 * Conversion:: Going from @acronym{MIME} to @acronym{MML} and vice versa. | |
566 * Flowed text:: Soft and hard newlines. | |
567 @end menu | |
568 | |
569 | |
570 @node Simple MML Example | |
571 @section Simple MML Example | |
572 | |
573 Here's a simple @samp{multipart/alternative}: | |
574 | |
575 @example | |
576 <#multipart type=alternative> | |
577 This is a plain text part. | |
578 <#part type=text/enriched> | |
579 <center>This is a centered enriched part</center> | |
580 <#/multipart> | |
581 @end example | |
582 | |
583 After running this through @code{mml-generate-mime}, we get this: | |
584 | |
585 @example | |
586 Content-Type: multipart/alternative; boundary="=-=-=" | |
587 | |
588 | |
589 --=-=-= | |
590 | |
591 | |
592 This is a plain text part. | |
593 | |
594 --=-=-= | |
595 Content-Type: text/enriched | |
596 | |
597 | |
598 <center>This is a centered enriched part</center> | |
599 | |
600 --=-=-=-- | |
601 @end example | |
602 | |
603 | |
604 @node MML Definition | |
605 @section MML Definition | |
606 | |
607 The @acronym{MML} language is very simple. It looks a bit like an SGML | |
608 application, but it's not. | |
609 | |
610 The main concept of @acronym{MML} is the @dfn{part}. Each part can be of a | |
611 different type or use a different charset. The way to delineate a part | |
612 is with a @samp{<#part ...>} tag. Multipart parts can be introduced | |
613 with the @samp{<#multipart ...>} tag. Parts are ended by the | |
614 @samp{<#/part>} or @samp{<#/multipart>} tags. Parts started with the | |
615 @samp{<#part ...>} tags are also closed by the next open tag. | |
616 | |
617 There's also the @samp{<#external ...>} tag. These introduce | |
618 @samp{external/message-body} parts. | |
619 | |
620 Each tag can contain zero or more parameters on the form | |
621 @samp{parameter=value}. The values may be enclosed in quotation marks, | |
622 but that's not necessary unless the value contains white space. So | |
623 @samp{filename=/home/user/#hello$^yes} is perfectly valid. | |
624 | |
625 The following parameters have meaning in @acronym{MML}; parameters that have no | |
626 meaning are ignored. The @acronym{MML} parameter names are the same as the | |
627 @acronym{MIME} parameter names; the things in the parentheses say which | |
628 header it will be used in. | |
629 | |
630 @table @samp | |
631 @item type | |
632 The @acronym{MIME} type of the part (@code{Content-Type}). | |
633 | |
634 @item filename | |
635 Use the contents of the file in the body of the part | |
636 (@code{Content-Disposition}). | |
637 | |
638 @item charset | |
639 The contents of the body of the part are to be encoded in the character | |
640 set specified (@code{Content-Type}). @xref{Charset Translation}. | |
641 | |
642 @item name | |
643 Might be used to suggest a file name if the part is to be saved | |
644 to a file (@code{Content-Type}). | |
645 | |
646 @item disposition | |
647 Valid values are @samp{inline} and @samp{attachment} | |
648 (@code{Content-Disposition}). | |
649 | |
650 @item encoding | |
651 Valid values are @samp{7bit}, @samp{8bit}, @samp{quoted-printable} and | |
652 @samp{base64} (@code{Content-Transfer-Encoding}). @xref{Charset | |
653 Translation}. | |
654 | |
655 @item description | |
656 A description of the part (@code{Content-Description}). | |
657 | |
658 @item creation-date | |
659 RFC822 date when the part was created (@code{Content-Disposition}). | |
660 | |
661 @item modification-date | |
662 RFC822 date when the part was modified (@code{Content-Disposition}). | |
663 | |
664 @item read-date | |
665 RFC822 date when the part was read (@code{Content-Disposition}). | |
666 | |
667 @item recipients | |
668 Who to encrypt/sign the part to. This field is used to override any | |
669 auto-detection based on the To/CC headers. | |
670 | |
671 @item sender | |
672 Identity used to sign the part. This field is used to override the | |
673 default key used. | |
674 | |
675 @item size | |
676 The size (in octets) of the part (@code{Content-Disposition}). | |
677 | |
678 @item sign | |
679 What technology to sign this @acronym{MML} part with (@code{smime}, @code{pgp} | |
680 or @code{pgpmime}) | |
681 | |
682 @item encrypt | |
683 What technology to encrypt this @acronym{MML} part with (@code{smime}, | |
684 @code{pgp} or @code{pgpmime}) | |
685 | |
686 @end table | |
687 | |
688 Parameters for @samp{text/plain}: | |
689 | |
690 @table @samp | |
691 @item format | |
692 Formatting parameter for the text, valid values include @samp{fixed} | |
693 (the default) and @samp{flowed}. Normally you do not specify this | |
694 manually, since it requires the textual body to be formatted in a | |
695 special way described in RFC 2646. @xref{Flowed text}. | |
696 @end table | |
697 | |
698 Parameters for @samp{application/octet-stream}: | |
699 | |
700 @table @samp | |
701 @item type | |
702 Type of the part; informal---meant for human readers | |
703 (@code{Content-Type}). | |
704 @end table | |
705 | |
706 Parameters for @samp{message/external-body}: | |
707 | |
708 @table @samp | |
709 @item access-type | |
710 A word indicating the supported access mechanism by which the file may | |
711 be obtained. Values include @samp{ftp}, @samp{anon-ftp}, @samp{tftp}, | |
712 @samp{localfile}, and @samp{mailserver}. (@code{Content-Type}.) | |
713 | |
714 @item expiration | |
715 The RFC822 date after which the file may no longer be fetched. | |
716 (@code{Content-Type}.) | |
717 | |
718 @item size | |
719 The size (in octets) of the file. (@code{Content-Type}.) | |
720 | |
721 @item permission | |
722 Valid values are @samp{read} and @samp{read-write} | |
723 (@code{Content-Type}). | |
724 | |
725 @end table | |
726 | |
727 Parameters for @samp{sign=smime}: | |
728 | |
729 @table @samp | |
730 | |
731 @item keyfile | |
732 File containing key and certificate for signer. | |
733 | |
734 @end table | |
735 | |
736 Parameters for @samp{encrypt=smime}: | |
737 | |
738 @table @samp | |
739 | |
740 @item certfile | |
741 File containing certificate for recipient. | |
742 | |
743 @end table | |
744 | |
745 | |
746 @node Advanced MML Example | |
747 @section Advanced MML Example | |
748 | |
749 Here's a complex multipart message. It's a @samp{multipart/mixed} that | |
750 contains many parts, one of which is a @samp{multipart/alternative}. | |
751 | |
752 @example | |
753 <#multipart type=mixed> | |
754 <#part type=image/jpeg filename=~/rms.jpg disposition=inline> | |
755 <#multipart type=alternative> | |
756 This is a plain text part. | |
757 <#part type=text/enriched name=enriched.txt> | |
758 <center>This is a centered enriched part</center> | |
759 <#/multipart> | |
760 This is a new plain text part. | |
761 <#part disposition=attachment> | |
762 This plain text part is an attachment. | |
763 <#/multipart> | |
764 @end example | |
765 | |
766 And this is the resulting @acronym{MIME} message: | |
767 | |
768 @example | |
769 Content-Type: multipart/mixed; boundary="=-=-=" | |
770 | |
771 | |
772 --=-=-= | |
773 | |
774 | |
775 | |
776 --=-=-= | |
777 Content-Type: image/jpeg; | |
778 filename="~/rms.jpg" | |
779 Content-Disposition: inline; | |
780 filename="~/rms.jpg" | |
781 Content-Transfer-Encoding: base64 | |
782 | |
783 /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRof | |
784 Hh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCAAwADABAREA/8QAHwAA | |
785 AQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQR | |
786 BRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RF | |
787 RkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ip | |
788 qrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEB | |
789 AAA/AO/rifFHjldNuGsrDa0qcSSHkA+gHrXKw+LtWLrMb+RgTyhbr+HSug07xNqV9fQtZrNI | |
790 AyiaE/NuBPOOOP0rvRNE880KOC8TbXXGCv1FPqjrF4LDR7u5L7SkTFT/ALWOP1xXgTuXfc7E | |
791 sx6nua6rwp4IvvEM8chCxWxOdzn7wz6V9AaB4S07w9p5itow0rDLSY5Pt9K43xO66P4xs71m | |
792 2QXiGCbA4yOVJ9+1aYORkdK434lyNH4ahCnG66VT9Nj15JFbPdX0MS43M4VQf5/yr2vSpLnw | |
793 5ZW8dlCZ8KFXjOPX0/mK6rSPEGt3Angu44fNEReHYNvIH3TzXDeKNO8RX+kSX2ouZkicTIOc | |
794 L+g7E810ulFjpVtv3bwgB3HJyK5L4quY/C9sVxk3ij/xx6850u7t1mtp/wDlpEw3An3Jr3Dw | |
795 34gsbWza4nBlhC5LDsaW6+IFgupQyCF3iHH7gA7c9R9ay7zx6t7aX9jHC4smhfBkGCvHGfrm | |
796 tLQ7hbnRrV1GPkAP1x1/Hr+Ncr8Vzjwrbf8AX6v/AKA9eQRyYlQk8Yx9K6XTNbkgia2ciSIn | |
797 7p5Ga9Atte0LTLKO6it4i7dVRFJDcZ4PvXN+JvEMF9bILVGXJLSZ4zkjivRPDaeX4b08HOTC | |
798 pOffmua+KkbS+GLVUGT9tT/0B68eeIpIFYjB70+OOVXyoOM9+M1eaWeCLzHPyHGO/NVWvJJm | |
799 jQ8KGH1NfQWhXSXmh2c8eArRLwO3HSv/2Q== | |
800 | |
801 --=-=-= | |
802 Content-Type: multipart/alternative; boundary="==-=-=" | |
803 | |
804 | |
805 --==-=-= | |
806 | |
807 | |
808 This is a plain text part. | |
809 | |
810 --==-=-= | |
811 Content-Type: text/enriched; | |
812 name="enriched.txt" | |
813 | |
814 | |
815 <center>This is a centered enriched part</center> | |
816 | |
817 --==-=-=-- | |
818 | |
819 --=-=-= | |
820 | |
821 This is a new plain text part. | |
822 | |
823 --=-=-= | |
824 Content-Disposition: attachment | |
825 | |
826 | |
827 This plain text part is an attachment. | |
828 | |
829 --=-=-=-- | |
830 @end example | |
831 | |
832 @node Encoding Customization | |
833 @section Encoding Customization | |
834 | |
835 @table @code | |
836 | |
837 @item mm-body-charset-encoding-alist | |
838 @vindex mm-body-charset-encoding-alist | |
839 Mapping from @acronym{MIME} charset to encoding to use. This variable is | |
840 usually used except, e.g., when other requirements force a specific | |
841 encoding (digitally signed messages require 7bit encodings). The | |
842 default is | |
843 | |
844 @lisp | |
845 ((iso-2022-jp . 7bit) | |
846 (iso-2022-jp-2 . 7bit) | |
847 (utf-16 . base64) | |
848 (utf-16be . base64) | |
849 (utf-16le . base64)) | |
850 @end lisp | |
851 | |
852 As an example, if you do not want to have ISO-8859-1 characters | |
853 quoted-printable encoded, you may add @code{(iso-8859-1 . 8bit)} to | |
854 this variable. You can override this setting on a per-message basis | |
855 by using the @code{encoding} @acronym{MML} tag (@pxref{MML Definition}). | |
856 | |
857 @item mm-coding-system-priorities | |
858 @vindex mm-coding-system-priorities | |
859 Prioritize coding systems to use for outgoing messages. The default | |
860 is @code{nil}, which means to use the defaults in Emacs, but is | |
861 @code{(iso-8859-1 iso-2022-jp iso-2022-jp-2 shift_jis utf-8)} when | |
862 running Emacs in the Japanese language environment. It is a list of | |
863 coding system symbols (aliases of coding systems are also allowed, use | |
864 @kbd{M-x describe-coding-system} to make sure you are specifying correct | |
865 coding system names). For example, if you have configured Emacs | |
866 to prefer UTF-8, but wish that outgoing messages should be sent in | |
867 ISO-8859-1 if possible, you can set this variable to | |
868 @code{(iso-8859-1)}. You can override this setting on a per-message | |
869 basis by using the @code{charset} @acronym{MML} tag (@pxref{MML Definition}). | |
870 | |
85712
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
871 As different hierarchies prefer different charsets, you may want to set |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
872 @code{mm-coding-system-priorities} according to the hierarchy in Gnus. |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
873 Here's an example: |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
874 |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
875 @c Corrections about preferred charsets are welcome. de, fr and fj |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
876 @c should be correct, I don't know about the rest (so these are only |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
877 @c examples): |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
878 @lisp |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
879 (add-to-list 'gnus-newsgroup-variables 'mm-coding-system-priorities) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
880 (setq gnus-parameters |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
881 (nconc |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
882 ;; Some charsets are just examples! |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
883 '(("^cn\\." ;; Chinese |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
884 (mm-coding-system-priorities |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
885 '(iso-8859-1 cn-big5 chinese-iso-7bit utf-8))) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
886 ("^cz\\.\\|^pl\\." ;; Central and Eastern European |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
887 (mm-coding-system-priorities '(iso-8859-2 utf-8))) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
888 ("^de\\." ;; German language |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
889 (mm-coding-system-priorities '(iso-8859-1 iso-8859-15 utf-8))) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
890 ("^fr\\." ;; French |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
891 (mm-coding-system-priorities '(iso-8859-15 iso-8859-1 utf-8))) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
892 ("^fj\\." ;; Japanese |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
893 (mm-coding-system-priorities |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
894 '(iso-8859-1 iso-2022-jp iso-2022-jp-2 shift_jis utf-8))) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
895 ("^ru\\." ;; Cyrillic |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
896 (mm-coding-system-priorities |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
897 '(koi8-r iso-8859-5 iso-8859-1 utf-8)))) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
898 gnus-parameters)) |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
899 @end lisp |
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
900 |
84292 | 901 @item mm-content-transfer-encoding-defaults |
902 @vindex mm-content-transfer-encoding-defaults | |
903 Mapping from @acronym{MIME} types to encoding to use. This variable is usually | |
904 used except, e.g., when other requirements force a safer encoding | |
905 (digitally signed messages require 7bit encoding). Besides the normal | |
906 @acronym{MIME} encodings, @code{qp-or-base64} may be used to indicate that for | |
907 each case the most efficient of quoted-printable and base64 should be | |
908 used. | |
909 | |
910 @code{qp-or-base64} has another effect. It will fold long lines so that | |
911 MIME parts may not be broken by MTA. So do @code{quoted-printable} and | |
912 @code{base64}. | |
913 | |
914 Note that it affects body encoding only when a part is a raw forwarded | |
915 message (which will be made by @code{gnus-summary-mail-forward} with the | |
916 arg 2 for example) or is neither the @samp{text/*} type nor the | |
917 @samp{message/*} type. Even though in those cases, you can override | |
918 this setting on a per-message basis by using the @code{encoding} | |
919 @acronym{MML} tag (@pxref{MML Definition}). | |
920 | |
921 @item mm-use-ultra-safe-encoding | |
922 @vindex mm-use-ultra-safe-encoding | |
923 When this is non-@code{nil}, it means that textual parts are encoded as | |
924 quoted-printable if they contain lines longer than 76 characters or | |
925 starting with "From " in the body. Non-7bit encodings (8bit, binary) | |
926 are generally disallowed. This reduce the probability that a non-8bit | |
927 clean MTA or MDA changes the message. This should never be set | |
928 directly, but bound by other functions when necessary (e.g., when | |
929 encoding messages that are to be digitally signed). | |
930 | |
931 @end table | |
932 | |
933 @node Charset Translation | |
934 @section Charset Translation | |
935 @cindex charsets | |
936 | |
937 During translation from @acronym{MML} to @acronym{MIME}, for each | |
938 @acronym{MIME} part which has been composed inside Emacs, an appropriate | |
939 charset has to be chosen. | |
940 | |
941 @vindex mail-parse-charset | |
942 If you are running a non-@sc{mule} Emacs, this process is simple: If the | |
943 part contains any non-@acronym{ASCII} (8-bit) characters, the @acronym{MIME} charset | |
944 given by @code{mail-parse-charset} (a symbol) is used. (Never set this | |
945 variable directly, though. If you want to change the default charset, | |
946 please consult the documentation of the package which you use to process | |
947 @acronym{MIME} messages. | |
948 @xref{Various Message Variables, , Various Message Variables, message, | |
949 Message Manual}, for example.) | |
950 If there are only @acronym{ASCII} characters, the @acronym{MIME} charset US-ASCII is | |
951 used, of course. | |
952 | |
953 @cindex MULE | |
954 @cindex UTF-8 | |
955 @cindex Unicode | |
956 @vindex mm-mime-mule-charset-alist | |
957 Things are slightly more complicated when running Emacs with @sc{mule} | |
958 support. In this case, a list of the @sc{mule} charsets used in the | |
959 part is obtained, and the @sc{mule} charsets are translated to | |
960 @acronym{MIME} charsets by consulting the table provided by Emacs itself | |
961 or the variable @code{mm-mime-mule-charset-alist} for XEmacs. | |
962 If this results in a single @acronym{MIME} charset, this is used to encode | |
963 the part. But if the resulting list of @acronym{MIME} charsets contains more | |
964 than one element, two things can happen: If it is possible to encode the | |
965 part via UTF-8, this charset is used. (For this, Emacs must support | |
966 the @code{utf-8} coding system, and the part must consist entirely of | |
967 characters which have Unicode counterparts.) If UTF-8 is not available | |
968 for some reason, the part is split into several ones, so that each one | |
969 can be encoded with a single @acronym{MIME} charset. The part can only be | |
970 split at line boundaries, though---if more than one @acronym{MIME} charset is | |
971 required to encode a single line, it is not possible to encode the part. | |
972 | |
973 When running Emacs with @sc{mule} support, the preferences for which | |
974 coding system to use is inherited from Emacs itself. This means that | |
975 if Emacs is set up to prefer UTF-8, it will be used when encoding | |
976 messages. You can modify this by altering the | |
977 @code{mm-coding-system-priorities} variable though (@pxref{Encoding | |
978 Customization}). | |
979 | |
980 The charset to be used can be overridden by setting the @code{charset} | |
981 @acronym{MML} tag (@pxref{MML Definition}) when composing the message. | |
982 | |
983 The encoding of characters (quoted-printable, 8bit etc) is orthogonal | |
984 to the discussion here, and is controlled by the variables | |
985 @code{mm-body-charset-encoding-alist} and | |
986 @code{mm-content-transfer-encoding-defaults} (@pxref{Encoding | |
987 Customization}). | |
988 | |
989 @node Conversion | |
990 @section Conversion | |
991 | |
992 @findex mime-to-mml | |
993 A (multipart) @acronym{MIME} message can be converted to @acronym{MML} | |
994 with the @code{mime-to-mml} function. It works on the message in the | |
995 current buffer, and substitutes @acronym{MML} markup for @acronym{MIME} | |
996 boundaries. Non-textual parts do not have their contents in the buffer, | |
997 but instead have the contents in separate buffers that are referred to | |
998 from the @acronym{MML} tags. | |
999 | |
1000 @findex mml-to-mime | |
1001 An @acronym{MML} message can be converted back to @acronym{MIME} by the | |
1002 @code{mml-to-mime} function. | |
1003 | |
1004 These functions are in certain senses ``lossy''---you will not get back | |
1005 an identical message if you run @code{mime-to-mml} and then | |
1006 @code{mml-to-mime}. Not only will trivial things like the order of the | |
1007 headers differ, but the contents of the headers may also be different. | |
1008 For instance, the original message may use base64 encoding on text, | |
1009 while @code{mml-to-mime} may decide to use quoted-printable encoding, and | |
1010 so on. | |
1011 | |
1012 In essence, however, these two functions should be the inverse of each | |
1013 other. The resulting contents of the message should remain equivalent, | |
1014 if not identical. | |
1015 | |
1016 | |
1017 @node Flowed text | |
1018 @section Flowed text | |
1019 @cindex format=flowed | |
1020 | |
1021 The Emacs @acronym{MIME} library will respect the @code{use-hard-newlines} | |
1022 variable (@pxref{Hard and Soft Newlines, ,Hard and Soft Newlines, | |
1023 emacs, Emacs Manual}) when encoding a message, and the | |
1024 ``format=flowed'' Content-Type parameter when decoding a message. | |
1025 | |
1026 On encoding text, regardless of @code{use-hard-newlines}, lines | |
1027 terminated by soft newline characters are filled together and wrapped | |
1028 after the column decided by @code{fill-flowed-encode-column}. | |
1029 Quotation marks (matching @samp{^>* ?}) are respected. The variable | |
1030 controls how the text will look in a client that does not support | |
1031 flowed text, the default is to wrap after 66 characters. If hard | |
1032 newline characters are not present in the buffer, no flow encoding | |
1033 occurs. | |
1034 | |
1035 On decoding flowed text, lines with soft newline characters are filled | |
1036 together and wrapped after the column decided by | |
1037 @code{fill-flowed-display-column}. The default is to wrap after | |
1038 @code{fill-column}. | |
1039 | |
1040 @table @code | |
1041 @item mm-fill-flowed | |
1042 @vindex mm-fill-flowed | |
1043 If non-@code{nil} a format=flowed article will be displayed flowed. | |
1044 @end table | |
1045 | |
1046 | |
1047 @node Interface Functions | |
1048 @chapter Interface Functions | |
1049 @cindex interface functions | |
1050 @cindex mail-parse | |
1051 | |
1052 The @code{mail-parse} library is an abstraction over the actual | |
1053 low-level libraries that are described in the next chapter. | |
1054 | |
1055 Standards change, and so programs have to change to fit in the new | |
1056 mold. For instance, RFC2045 describes a syntax for the | |
1057 @code{Content-Type} header that only allows @acronym{ASCII} characters in the | |
1058 parameter list. RFC2231 expands on RFC2045 syntax to provide a scheme | |
1059 for continuation headers and non-@acronym{ASCII} characters. | |
1060 | |
1061 The traditional way to deal with this is just to update the library | |
1062 functions to parse the new syntax. However, this is sometimes the wrong | |
1063 thing to do. In some instances it may be vital to be able to understand | |
1064 both the old syntax as well as the new syntax, and if there is only one | |
1065 library, one must choose between the old version of the library and the | |
1066 new version of the library. | |
1067 | |
1068 The Emacs @acronym{MIME} library takes a different tack. It defines a | |
1069 series of low-level libraries (@file{rfc2047.el}, @file{rfc2231.el} | |
1070 and so on) that parses strictly according to the corresponding | |
1071 standard. However, normal programs would not use the functions | |
1072 provided by these libraries directly, but instead use the functions | |
1073 provided by the @code{mail-parse} library. The functions in this | |
1074 library are just aliases to the corresponding functions in the latest | |
1075 low-level libraries. Using this scheme, programs get a consistent | |
1076 interface they can use, and library developers are free to create | |
1077 write code that handles new standards. | |
1078 | |
1079 The following functions are defined by this library: | |
1080 | |
1081 @table @code | |
1082 @item mail-header-parse-content-type | |
1083 @findex mail-header-parse-content-type | |
1084 Parse a @code{Content-Type} header and return a list on the following | |
1085 format: | |
1086 | |
1087 @lisp | |
1088 ("type/subtype" | |
1089 (attribute1 . value1) | |
1090 (attribute2 . value2) | |
1091 ...) | |
1092 @end lisp | |
1093 | |
1094 Here's an example: | |
1095 | |
1096 @example | |
1097 (mail-header-parse-content-type | |
1098 "image/gif; name=\"b980912.gif\"") | |
1099 @result{} ("image/gif" (name . "b980912.gif")) | |
1100 @end example | |
1101 | |
1102 @item mail-header-parse-content-disposition | |
1103 @findex mail-header-parse-content-disposition | |
1104 Parse a @code{Content-Disposition} header and return a list on the same | |
1105 format as the function above. | |
1106 | |
1107 @item mail-content-type-get | |
1108 @findex mail-content-type-get | |
1109 Takes two parameters---a list on the format above, and an attribute. | |
1110 Returns the value of the attribute. | |
1111 | |
1112 @example | |
1113 (mail-content-type-get | |
1114 '("image/gif" (name . "b980912.gif")) 'name) | |
1115 @result{} "b980912.gif" | |
1116 @end example | |
1117 | |
1118 @item mail-header-encode-parameter | |
1119 @findex mail-header-encode-parameter | |
1120 Takes a parameter string and returns an encoded version of the string. | |
1121 This is used for parameters in headers like @code{Content-Type} and | |
1122 @code{Content-Disposition}. | |
1123 | |
1124 @item mail-header-remove-comments | |
1125 @findex mail-header-remove-comments | |
1126 Return a comment-free version of a header. | |
1127 | |
1128 @example | |
1129 (mail-header-remove-comments | |
1130 "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)") | |
1131 @result{} "Gnus/5.070027 " | |
1132 @end example | |
1133 | |
1134 @item mail-header-remove-whitespace | |
1135 @findex mail-header-remove-whitespace | |
1136 Remove linear white space from a header. Space inside quoted strings | |
1137 and comments is preserved. | |
1138 | |
1139 @example | |
1140 (mail-header-remove-whitespace | |
1141 "image/gif; name=\"Name with spaces\"") | |
1142 @result{} "image/gif;name=\"Name with spaces\"" | |
1143 @end example | |
1144 | |
1145 @item mail-header-get-comment | |
1146 @findex mail-header-get-comment | |
1147 Return the last comment in a header. | |
1148 | |
1149 @example | |
1150 (mail-header-get-comment | |
1151 "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)") | |
1152 @result{} "Finnish Landrace" | |
1153 @end example | |
1154 | |
1155 @item mail-header-parse-address | |
1156 @findex mail-header-parse-address | |
1157 Parse an address and return a list containing the mailbox and the | |
1158 plaintext name. | |
1159 | |
1160 @example | |
1161 (mail-header-parse-address | |
1162 "Hrvoje Niksic <hniksic@@srce.hr>") | |
1163 @result{} ("hniksic@@srce.hr" . "Hrvoje Niksic") | |
1164 @end example | |
1165 | |
1166 @item mail-header-parse-addresses | |
1167 @findex mail-header-parse-addresses | |
1168 Parse a string with list of addresses and return a list of elements like | |
1169 the one described above. | |
1170 | |
1171 @example | |
1172 (mail-header-parse-addresses | |
1173 "Hrvoje Niksic <hniksic@@srce.hr>, Steinar Bang <sb@@metis.no>") | |
1174 @result{} (("hniksic@@srce.hr" . "Hrvoje Niksic") | |
1175 ("sb@@metis.no" . "Steinar Bang")) | |
1176 @end example | |
1177 | |
1178 @item mail-header-parse-date | |
1179 @findex mail-header-parse-date | |
1180 Parse a date string and return an Emacs time structure. | |
1181 | |
1182 @item mail-narrow-to-head | |
1183 @findex mail-narrow-to-head | |
1184 Narrow the buffer to the header section of the buffer. Point is placed | |
1185 at the beginning of the narrowed buffer. | |
1186 | |
1187 @item mail-header-narrow-to-field | |
1188 @findex mail-header-narrow-to-field | |
1189 Narrow the buffer to the header under point. Understands continuation | |
1190 headers. | |
1191 | |
1192 @item mail-header-fold-field | |
1193 @findex mail-header-fold-field | |
1194 Fold the header under point. | |
1195 | |
1196 @item mail-header-unfold-field | |
1197 @findex mail-header-unfold-field | |
1198 Unfold the header under point. | |
1199 | |
1200 @item mail-header-field-value | |
1201 @findex mail-header-field-value | |
1202 Return the value of the field under point. | |
1203 | |
1204 @item mail-encode-encoded-word-region | |
1205 @findex mail-encode-encoded-word-region | |
1206 Encode the non-@acronym{ASCII} words in the region. For instance, | |
85712
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
1207 @samp{Na@"{@dotless{i}}ve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}. |
84292 | 1208 |
1209 @item mail-encode-encoded-word-buffer | |
1210 @findex mail-encode-encoded-word-buffer | |
1211 Encode the non-@acronym{ASCII} words in the current buffer. This function is | |
1212 meant to be called narrowed to the headers of a message. | |
1213 | |
1214 @item mail-encode-encoded-word-string | |
1215 @findex mail-encode-encoded-word-string | |
1216 Encode the words that need encoding in a string, and return the result. | |
1217 | |
1218 @example | |
1219 (mail-encode-encoded-word-string | |
85712
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
1220 "This is na@"{@dotless{i}}ve, baby") |
84292 | 1221 @result{} "This is =?iso-8859-1?q?na=EFve,?= baby" |
1222 @end example | |
1223 | |
1224 @item mail-decode-encoded-word-region | |
1225 @findex mail-decode-encoded-word-region | |
1226 Decode the encoded words in the region. | |
1227 | |
1228 @item mail-decode-encoded-word-string | |
1229 @findex mail-decode-encoded-word-string | |
1230 Decode the encoded words in the string and return the result. | |
1231 | |
1232 @example | |
1233 (mail-decode-encoded-word-string | |
1234 "This is =?iso-8859-1?q?na=EFve,?= baby") | |
85712
a3c27999decb
Update Gnus to No Gnus 0.7 from the Gnus CVS trunk
Miles Bader <miles@gnu.org>
parents:
84329
diff
changeset
|
1235 @result{} "This is na@"{@dotless{i}}ve, baby" |
84292 | 1236 @end example |
1237 | |
1238 @end table | |
1239 | |
1240 Currently, @code{mail-parse} is an abstraction over @code{ietf-drums}, | |
1241 @code{rfc2047}, @code{rfc2045} and @code{rfc2231}. These are documented | |
1242 in the subsequent sections. | |
1243 | |
1244 | |
1245 | |
1246 @node Basic Functions | |
1247 @chapter Basic Functions | |
1248 | |
1249 This chapter describes the basic, ground-level functions for parsing and | |
1250 handling. Covered here is parsing @code{From} lines, removing comments | |
1251 from header lines, decoding encoded words, parsing date headers and so | |
1252 on. High-level functionality is dealt with in the first chapter | |
1253 (@pxref{Decoding and Viewing}). | |
1254 | |
1255 @menu | |
1256 * rfc2045:: Encoding @code{Content-Type} headers. | |
1257 * rfc2231:: Parsing @code{Content-Type} headers. | |
1258 * ietf-drums:: Handling mail headers defined by RFC822bis. | |
1259 * rfc2047:: En/decoding encoded words in headers. | |
1260 * time-date:: Functions for parsing dates and manipulating time. | |
1261 * qp:: Quoted-Printable en/decoding. | |
1262 * base64:: Base64 en/decoding. | |
1263 * binhex:: Binhex decoding. | |
1264 * uudecode:: Uuencode decoding. | |
1265 * yenc:: Yenc decoding. | |
1266 * rfc1843:: Decoding HZ-encoded text. | |
1267 * mailcap:: How parts are displayed is specified by the @file{.mailcap} file | |
1268 @end menu | |
1269 | |
1270 | |
1271 @node rfc2045 | |
1272 @section rfc2045 | |
1273 | |
1274 RFC2045 is the ``main'' @acronym{MIME} document, and as such, one would | |
1275 imagine that there would be a lot to implement. But there isn't, since | |
1276 most of the implementation details are delegated to the subsequent | |
1277 RFCs. | |
1278 | |
1279 So @file{rfc2045.el} has only a single function: | |
1280 | |
1281 @table @code | |
1282 @item rfc2045-encode-string | |
1283 @findex rfc2045-encode-string | |
1284 Takes a parameter and a value and returns a @samp{PARAM=VALUE} string. | |
1285 @var{value} will be quoted if there are non-safe characters in it. | |
1286 @end table | |
1287 | |
1288 | |
1289 @node rfc2231 | |
1290 @section rfc2231 | |
1291 | |
1292 RFC2231 defines a syntax for the @code{Content-Type} and | |
1293 @code{Content-Disposition} headers. Its snappy name is @dfn{MIME | |
1294 Parameter Value and Encoded Word Extensions: Character Sets, Languages, | |
1295 and Continuations}. | |
1296 | |
1297 In short, these headers look something like this: | |
1298 | |
1299 @example | |
1300 Content-Type: application/x-stuff; | |
1301 title*0*=us-ascii'en'This%20is%20even%20more%20; | |
1302 title*1*=%2A%2A%2Afun%2A%2A%2A%20; | |
1303 title*2="isn't it!" | |
1304 @end example | |
1305 | |
1306 They usually aren't this bad, though. | |
1307 | |
1308 The following functions are defined by this library: | |
1309 | |
1310 @table @code | |
1311 @item rfc2231-parse-string | |
1312 @findex rfc2231-parse-string | |
1313 Parse a @code{Content-Type} header and return a list describing its | |
1314 elements. | |
1315 | |
1316 @example | |
1317 (rfc2231-parse-string | |
1318 "application/x-stuff; | |
1319 title*0*=us-ascii'en'This%20is%20even%20more%20; | |
1320 title*1*=%2A%2A%2Afun%2A%2A%2A%20; | |
1321 title*2=\"isn't it!\"") | |
1322 @result{} ("application/x-stuff" | |
1323 (title . "This is even more ***fun*** isn't it!")) | |
1324 @end example | |
1325 | |
1326 @item rfc2231-get-value | |
1327 @findex rfc2231-get-value | |
1328 Takes one of the lists on the format above and returns | |
1329 the value of the specified attribute. | |
1330 | |
1331 @item rfc2231-encode-string | |
1332 @findex rfc2231-encode-string | |
1333 Encode a parameter in headers likes @code{Content-Type} and | |
1334 @code{Content-Disposition}. | |
1335 | |
1336 @end table | |
1337 | |
1338 | |
1339 @node ietf-drums | |
1340 @section ietf-drums | |
1341 | |
1342 @dfn{drums} is an IETF working group that is working on the replacement | |
1343 for RFC822. | |
1344 | |
1345 The functions provided by this library include: | |
1346 | |
1347 @table @code | |
1348 @item ietf-drums-remove-comments | |
1349 @findex ietf-drums-remove-comments | |
1350 Remove the comments from the argument and return the results. | |
1351 | |
1352 @item ietf-drums-remove-whitespace | |
1353 @findex ietf-drums-remove-whitespace | |
1354 Remove linear white space from the string and return the results. | |
1355 Spaces inside quoted strings and comments are left untouched. | |
1356 | |
1357 @item ietf-drums-get-comment | |
1358 @findex ietf-drums-get-comment | |
1359 Return the last most comment from the string. | |
1360 | |
1361 @item ietf-drums-parse-address | |
1362 @findex ietf-drums-parse-address | |
1363 Parse an address string and return a list that contains the mailbox and | |
1364 the plain text name. | |
1365 | |
1366 @item ietf-drums-parse-addresses | |
1367 @findex ietf-drums-parse-addresses | |
1368 Parse a string that contains any number of comma-separated addresses and | |
1369 return a list that contains mailbox/plain text pairs. | |
1370 | |
1371 @item ietf-drums-parse-date | |
1372 @findex ietf-drums-parse-date | |
1373 Parse a date string and return an Emacs time structure. | |
1374 | |
1375 @item ietf-drums-narrow-to-header | |
1376 @findex ietf-drums-narrow-to-header | |
1377 Narrow the buffer to the header section of the current buffer. | |
1378 | |
1379 @end table | |
1380 | |
1381 | |
1382 @node rfc2047 | |
1383 @section rfc2047 | |
1384 | |
1385 RFC2047 (Message Header Extensions for Non-@acronym{ASCII} Text) specifies how | |
1386 non-@acronym{ASCII} text in headers are to be encoded. This is actually rather | |
1387 complicated, so a number of variables are necessary to tweak what this | |
1388 library does. | |
1389 | |
1390 The following variables are tweakable: | |
1391 | |
1392 @table @code | |
1393 @item rfc2047-header-encoding-alist | |
1394 @vindex rfc2047-header-encoding-alist | |
1395 This is an alist of header / encoding-type pairs. Its main purpose is | |
1396 to prevent encoding of certain headers. | |
1397 | |
1398 The keys can either be header regexps, or @code{t}. | |
1399 | |
1400 The values can be @code{nil}, in which case the header(s) in question | |
1401 won't be encoded, @code{mime}, which means that they will be encoded, or | |
1402 @code{address-mime}, which means the header(s) will be encoded carefully | |
1403 assuming they contain addresses. | |
1404 | |
1405 @item rfc2047-charset-encoding-alist | |
1406 @vindex rfc2047-charset-encoding-alist | |
1407 RFC2047 specifies two forms of encoding---@code{Q} (a | |
1408 Quoted-Printable-like encoding) and @code{B} (base64). This alist | |
1409 specifies which charset should use which encoding. | |
1410 | |
1411 @item rfc2047-encode-function-alist | |
1412 @vindex rfc2047-encode-function-alist | |
1413 This is an alist of encoding / function pairs. The encodings are | |
1414 @code{Q}, @code{B} and @code{nil}. | |
1415 | |
1416 @item rfc2047-encoded-word-regexp | |
1417 @vindex rfc2047-encoded-word-regexp | |
1418 When decoding words, this library looks for matches to this regexp. | |
1419 | |
87097 | 1420 @item rfc2047-encoded-word-regexp-loose |
1421 @vindex rfc2047-encoded-word-regexp-loose | |
1422 This is a version from which the regexp for the Q encoding pattern of | |
1423 @code{rfc2047-encoded-word-regexp} is made loose. | |
1424 | |
84292 | 1425 @item rfc2047-encode-encoded-words |
1426 @vindex rfc2047-encode-encoded-words | |
1427 The boolean variable specifies whether encoded words | |
87097 | 1428 (e.g. @samp{=?us-ascii?q?hello?=}) should be encoded again. |
1429 @code{rfc2047-encoded-word-regexp} is used to look for such words. | |
1430 | |
1431 @item rfc2047-allow-irregular-q-encoded-words | |
1432 @vindex rfc2047-allow-irregular-q-encoded-words | |
1433 The boolean variable specifies whether irregular Q encoded words | |
1434 (e.g. @samp{=?us-ascii?q?hello??=}) should be decoded. If it is | |
1435 non-@code{nil}, @code{rfc2047-encoded-word-regexp-loose} is used instead | |
1436 of @code{rfc2047-encoded-word-regexp} to look for encoded words. | |
84292 | 1437 |
1438 @end table | |
1439 | |
1440 Those were the variables, and these are this functions: | |
1441 | |
1442 @table @code | |
1443 @item rfc2047-narrow-to-field | |
1444 @findex rfc2047-narrow-to-field | |
1445 Narrow the buffer to the header on the current line. | |
1446 | |
1447 @item rfc2047-encode-message-header | |
1448 @findex rfc2047-encode-message-header | |
1449 Should be called narrowed to the header of a message. Encodes according | |
1450 to @code{rfc2047-header-encoding-alist}. | |
1451 | |
1452 @item rfc2047-encode-region | |
1453 @findex rfc2047-encode-region | |
1454 Encodes all encodable words in the region specified. | |
1455 | |
1456 @item rfc2047-encode-string | |
1457 @findex rfc2047-encode-string | |
1458 Encode a string and return the results. | |
1459 | |
1460 @item rfc2047-decode-region | |
1461 @findex rfc2047-decode-region | |
1462 Decode the encoded words in the region. | |
1463 | |
1464 @item rfc2047-decode-string | |
1465 @findex rfc2047-decode-string | |
1466 Decode a string and return the results. | |
1467 | |
1468 @item rfc2047-encode-parameter | |
1469 @findex rfc2047-encode-parameter | |
1470 Encode a parameter in the RFC2047-like style. This is a replacement for | |
1471 the @code{rfc2231-encode-string} function. @xref{rfc2231}. | |
1472 | |
1473 When attaching files as @acronym{MIME} parts, we should use the RFC2231 | |
1474 encoding to specify the file names containing non-@acronym{ASCII} | |
1475 characters. However, many mail softwares don't support it in practice | |
1476 and recipients won't be able to extract files with correct names. | |
1477 Instead, the RFC2047-like encoding is acceptable generally. This | |
1478 function provides the very RFC2047-like encoding, resigning to such a | |
1479 regrettable trend. To use it, put the following line in your | |
1480 @file{~/.gnus.el} file: | |
1481 | |
1482 @lisp | |
1483 (defalias 'mail-header-encode-parameter 'rfc2047-encode-parameter) | |
1484 @end lisp | |
1485 | |
1486 @end table | |
1487 | |
1488 | |
1489 @node time-date | |
1490 @section time-date | |
1491 | |
1492 While not really a part of the @acronym{MIME} library, it is convenient to | |
1493 document this library here. It deals with parsing @code{Date} headers | |
1494 and manipulating time. (Not by using tesseracts, though, I'm sorry to | |
1495 say.) | |
1496 | |
1497 These functions convert between five formats: A date string, an Emacs | |
1498 time structure, a decoded time list, a second number, and a day number. | |
1499 | |
1500 Here's a bunch of time/date/second/day examples: | |
1501 | |
1502 @example | |
1503 (parse-time-string "Sat Sep 12 12:21:54 1998 +0200") | |
1504 @result{} (54 21 12 12 9 1998 6 nil 7200) | |
1505 | |
1506 (date-to-time "Sat Sep 12 12:21:54 1998 +0200") | |
1507 @result{} (13818 19266) | |
1508 | |
1509 (time-to-seconds '(13818 19266)) | |
1510 @result{} 905595714.0 | |
1511 | |
1512 (seconds-to-time 905595714.0) | |
1513 @result{} (13818 19266 0) | |
1514 | |
1515 (time-to-days '(13818 19266)) | |
1516 @result{} 729644 | |
1517 | |
1518 (days-to-time 729644) | |
1519 @result{} (961933 65536) | |
1520 | |
1521 (time-since '(13818 19266)) | |
1522 @result{} (0 430) | |
1523 | |
1524 (time-less-p '(13818 19266) '(13818 19145)) | |
1525 @result{} nil | |
1526 | |
1527 (subtract-time '(13818 19266) '(13818 19145)) | |
1528 @result{} (0 121) | |
1529 | |
1530 (days-between "Sat Sep 12 12:21:54 1998 +0200" | |
1531 "Sat Sep 07 12:21:54 1998 +0200") | |
1532 @result{} 5 | |
1533 | |
1534 (date-leap-year-p 2000) | |
1535 @result{} t | |
1536 | |
1537 (time-to-day-in-year '(13818 19266)) | |
1538 @result{} 255 | |
1539 | |
1540 (time-to-number-of-days | |
1541 (time-since | |
1542 (date-to-time "Mon, 01 Jan 2001 02:22:26 GMT"))) | |
1543 @result{} 4.146122685185185 | |
1544 @end example | |
1545 | |
1546 And finally, we have @code{safe-date-to-time}, which does the same as | |
1547 @code{date-to-time}, but returns a zero time if the date is | |
1548 syntactically malformed. | |
1549 | |
1550 The five data representations used are the following: | |
1551 | |
1552 @table @var | |
1553 @item date | |
1554 An RFC822 (or similar) date string. For instance: @code{"Sat Sep 12 | |
1555 12:21:54 1998 +0200"}. | |
1556 | |
1557 @item time | |
1558 An internal Emacs time. For instance: @code{(13818 26466)}. | |
1559 | |
1560 @item seconds | |
1561 A floating point representation of the internal Emacs time. For | |
1562 instance: @code{905595714.0}. | |
1563 | |
1564 @item days | |
1565 An integer number representing the number of days since 00000101. For | |
1566 instance: @code{729644}. | |
1567 | |
1568 @item decoded time | |
1569 A list of decoded time. For instance: @code{(54 21 12 12 9 1998 6 t | |
1570 7200)}. | |
1571 @end table | |
1572 | |
1573 All the examples above represent the same moment. | |
1574 | |
1575 These are the functions available: | |
1576 | |
1577 @table @code | |
1578 @item date-to-time | |
1579 Take a date and return a time. | |
1580 | |
1581 @item time-to-seconds | |
1582 Take a time and return seconds. | |
1583 | |
1584 @item seconds-to-time | |
1585 Take seconds and return a time. | |
1586 | |
1587 @item time-to-days | |
1588 Take a time and return days. | |
1589 | |
1590 @item days-to-time | |
1591 Take days and return a time. | |
1592 | |
1593 @item date-to-day | |
1594 Take a date and return days. | |
1595 | |
1596 @item time-to-number-of-days | |
1597 Take a time and return the number of days that represents. | |
1598 | |
1599 @item safe-date-to-time | |
1600 Take a date and return a time. If the date is not syntactically valid, | |
1601 return a ``zero'' time. | |
1602 | |
1603 @item time-less-p | |
1604 Take two times and say whether the first time is less (i. e., earlier) | |
1605 than the second time. | |
1606 | |
1607 @item time-since | |
1608 Take a time and return a time saying how long it was since that time. | |
1609 | |
1610 @item subtract-time | |
1611 Take two times and subtract the second from the first. I. e., return | |
1612 the time between the two times. | |
1613 | |
1614 @item days-between | |
1615 Take two days and return the number of days between those two days. | |
1616 | |
1617 @item date-leap-year-p | |
1618 Take a year number and say whether it's a leap year. | |
1619 | |
1620 @item time-to-day-in-year | |
1621 Take a time and return the day number within the year that the time is | |
1622 in. | |
1623 | |
1624 @end table | |
1625 | |
1626 | |
1627 @node qp | |
1628 @section qp | |
1629 | |
1630 This library deals with decoding and encoding Quoted-Printable text. | |
1631 | |
1632 Very briefly explained, qp encoding means translating all 8-bit | |
1633 characters (and lots of control characters) into things that look like | |
1634 @samp{=EF}; that is, an equal sign followed by the byte encoded as a hex | |
1635 string. | |
1636 | |
1637 The following functions are defined by the library: | |
1638 | |
1639 @table @code | |
1640 @item quoted-printable-decode-region | |
1641 @findex quoted-printable-decode-region | |
1642 QP-decode all the encoded text in the specified region. | |
1643 | |
1644 @item quoted-printable-decode-string | |
1645 @findex quoted-printable-decode-string | |
1646 Decode the QP-encoded text in a string and return the results. | |
1647 | |
1648 @item quoted-printable-encode-region | |
1649 @findex quoted-printable-encode-region | |
1650 QP-encode all the encodable characters in the specified region. The third | |
1651 optional parameter @var{fold} specifies whether to fold long lines. | |
1652 (Long here means 72.) | |
1653 | |
1654 @item quoted-printable-encode-string | |
1655 @findex quoted-printable-encode-string | |
1656 QP-encode all the encodable characters in a string and return the | |
1657 results. | |
1658 | |
1659 @end table | |
1660 | |
1661 | |
1662 @node base64 | |
1663 @section base64 | |
1664 @cindex base64 | |
1665 | |
1666 Base64 is an encoding that encodes three bytes into four characters, | |
1667 thereby increasing the size by about 33%. The alphabet used for | |
1668 encoding is very resistant to mangling during transit. | |
1669 | |
1670 The following functions are defined by this library: | |
1671 | |
1672 @table @code | |
1673 @item base64-encode-region | |
1674 @findex base64-encode-region | |
1675 base64 encode the selected region. Return the length of the encoded | |
1676 text. Optional third argument @var{no-line-break} means do not break | |
1677 long lines into shorter lines. | |
1678 | |
1679 @item base64-encode-string | |
1680 @findex base64-encode-string | |
1681 base64 encode a string and return the result. | |
1682 | |
1683 @item base64-decode-region | |
1684 @findex base64-decode-region | |
1685 base64 decode the selected region. Return the length of the decoded | |
1686 text. If the region can't be decoded, return @code{nil} and don't | |
1687 modify the buffer. | |
1688 | |
1689 @item base64-decode-string | |
1690 @findex base64-decode-string | |
1691 base64 decode a string and return the result. If the string can't be | |
1692 decoded, @code{nil} is returned. | |
1693 | |
1694 @end table | |
1695 | |
1696 | |
1697 @node binhex | |
1698 @section binhex | |
1699 @cindex binhex | |
1700 @cindex Apple | |
1701 @cindex Macintosh | |
1702 | |
1703 @code{binhex} is an encoding that originated in Macintosh environments. | |
1704 The following function is supplied to deal with these: | |
1705 | |
1706 @table @code | |
1707 @item binhex-decode-region | |
1708 @findex binhex-decode-region | |
1709 Decode the encoded text in the region. If given a third parameter, only | |
1710 decode the @code{binhex} header and return the filename. | |
1711 | |
1712 @end table | |
1713 | |
1714 @node uudecode | |
1715 @section uudecode | |
1716 @cindex uuencode | |
1717 @cindex uudecode | |
1718 | |
1719 @code{uuencode} is probably still the most popular encoding of binaries | |
1720 used on Usenet, although @code{base64} rules the mail world. | |
1721 | |
1722 The following function is supplied by this package: | |
1723 | |
1724 @table @code | |
1725 @item uudecode-decode-region | |
1726 @findex uudecode-decode-region | |
1727 Decode the text in the region. | |
1728 @end table | |
1729 | |
1730 | |
1731 @node yenc | |
1732 @section yenc | |
1733 @cindex yenc | |
1734 | |
1735 @code{yenc} is used for encoding binaries on Usenet. The following | |
1736 function is supplied by this package: | |
1737 | |
1738 @table @code | |
1739 @item yenc-decode-region | |
1740 @findex yenc-decode-region | |
1741 Decode the encoded text in the region. | |
1742 | |
1743 @end table | |
1744 | |
1745 | |
1746 @node rfc1843 | |
1747 @section rfc1843 | |
1748 @cindex rfc1843 | |
1749 @cindex HZ | |
1750 @cindex Chinese | |
1751 | |
1752 RFC1843 deals with mixing Chinese and @acronym{ASCII} characters in messages. In | |
1753 essence, RFC1843 switches between @acronym{ASCII} and Chinese by doing this: | |
1754 | |
1755 @example | |
1756 This sentence is in @acronym{ASCII}. | |
1757 The next sentence is in GB.~@{<:Ky2;S@{#,NpJ)l6HK!#~@}Bye. | |
1758 @end example | |
1759 | |
1760 Simple enough, and widely used in China. | |
1761 | |
1762 The following functions are available to handle this encoding: | |
1763 | |
1764 @table @code | |
1765 @item rfc1843-decode-region | |
1766 Decode HZ-encoded text in the region. | |
1767 | |
1768 @item rfc1843-decode-string | |
1769 Decode a HZ-encoded string and return the result. | |
1770 | |
1771 @end table | |
1772 | |
1773 | |
1774 @node mailcap | |
1775 @section mailcap | |
1776 | |
1777 The @file{~/.mailcap} file is parsed by most @acronym{MIME}-aware message | |
1778 handlers and describes how elements are supposed to be displayed. | |
1779 Here's an example file: | |
1780 | |
1781 @example | |
1782 image/*; gimp -8 %s | |
1783 audio/wav; wavplayer %s | |
1784 application/msword; catdoc %s ; copiousoutput ; nametemplate=%s.doc | |
1785 @end example | |
1786 | |
1787 This says that all image files should be displayed with @code{gimp}, | |
1788 that WAVE audio files should be played by @code{wavplayer}, and that | |
1789 MS-WORD files should be inlined by @code{catdoc}. | |
1790 | |
1791 The @code{mailcap} library parses this file, and provides functions for | |
1792 matching types. | |
1793 | |
1794 @table @code | |
1795 @item mailcap-mime-data | |
1796 @vindex mailcap-mime-data | |
1797 This variable is an alist of alists containing backup viewing rules. | |
1798 | |
1799 @end table | |
1800 | |
1801 Interface functions: | |
1802 | |
1803 @table @code | |
1804 @item mailcap-parse-mailcaps | |
1805 @findex mailcap-parse-mailcaps | |
1806 Parse the @file{~/.mailcap} file. | |
1807 | |
1808 @item mailcap-mime-info | |
1809 Takes a @acronym{MIME} type as its argument and returns the matching viewer. | |
1810 | |
1811 @end table | |
1812 | |
1813 | |
1814 | |
1815 | |
1816 @node Standards | |
1817 @chapter Standards | |
1818 | |
1819 The Emacs @acronym{MIME} library implements handling of various elements | |
1820 according to a (somewhat) large number of RFCs, drafts and standards | |
1821 documents. This chapter lists the relevant ones. They can all be | |
1822 fetched from @uref{http://quimby.gnus.org/notes/}. | |
1823 | |
1824 @table @dfn | |
1825 @item RFC822 | |
1826 @itemx STD11 | |
1827 Standard for the Format of ARPA Internet Text Messages. | |
1828 | |
1829 @item RFC1036 | |
1830 Standard for Interchange of USENET Messages | |
1831 | |
1832 @item RFC2045 | |
1833 Format of Internet Message Bodies | |
1834 | |
1835 @item RFC2046 | |
1836 Media Types | |
1837 | |
1838 @item RFC2047 | |
1839 Message Header Extensions for Non-@acronym{ASCII} Text | |
1840 | |
1841 @item RFC2048 | |
1842 Registration Procedures | |
1843 | |
1844 @item RFC2049 | |
1845 Conformance Criteria and Examples | |
1846 | |
1847 @item RFC2231 | |
1848 @acronym{MIME} Parameter Value and Encoded Word Extensions: Character Sets, | |
1849 Languages, and Continuations | |
1850 | |
1851 @item RFC1843 | |
1852 HZ - A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and | |
1853 @acronym{ASCII} characters | |
1854 | |
1855 @item draft-ietf-drums-msg-fmt-05.txt | |
1856 Draft for the successor of RFC822 | |
1857 | |
1858 @item RFC2112 | |
1859 The @acronym{MIME} Multipart/Related Content-type | |
1860 | |
1861 @item RFC1892 | |
1862 The Multipart/Report Content Type for the Reporting of Mail System | |
1863 Administrative Messages | |
1864 | |
1865 @item RFC2183 | |
1866 Communicating Presentation Information in Internet Messages: The | |
1867 Content-Disposition Header Field | |
1868 | |
1869 @item RFC2646 | |
1870 Documentation of the text/plain format parameter for flowed text. | |
1871 | |
1872 @end table | |
1873 | |
1874 @node GNU Free Documentation License | |
1875 @chapter GNU Free Documentation License | |
1876 @include doclicense.texi | |
1877 | |
1878 @node Index | |
1879 @chapter Index | |
1880 @printindex cp | |
1881 | |
1882 @bye | |
1883 | |
1884 | |
1885 @c Local Variables: | |
1886 @c mode: texinfo | |
1887 @c coding: iso-8859-1 | |
1888 @c End: | |
1889 | |
1890 @ignore | |
1891 arch-tag: c7ef2fd0-a91c-4e10-aa52-c1a2b11b1a8d | |
1892 @end ignore |