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