Commit | Line | Data |
---|---|---|
23f87bed | 1 | \input texinfo |
dd8839b0 | 2 | |
a1720df0 | 3 | @setfilename ../info/emacs-mime |
dd8839b0 DL |
4 | @settitle Emacs MIME Manual |
5 | @synindex fn cp | |
6 | @synindex vr cp | |
7 | @synindex pg cp | |
dd8839b0 | 8 | |
18f952d5 | 9 | @copying |
dd8839b0 DL |
10 | This file documents the Emacs MIME interface functionality. |
11 | ||
8d99e09d | 12 | Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 |
f3f01d5d | 13 | Free Software Foundation, Inc. |
dd8839b0 | 14 | |
18f952d5 | 15 | @quotation |
dd8839b0 | 16 | Permission is granted to copy, distribute and/or modify this document |
678e7c71 | 17 | under the terms of the GNU Free Documentation License, Version 1.2 or |
c5c46a26 DL |
18 | any later version published by the Free Software Foundation; with no |
19 | Invariant Sections, with the Front-Cover texts being ``A GNU | |
23f87bed | 20 | Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
dd8839b0 | 21 | license is included in the section entitled ``GNU Free Documentation |
2482f038 | 22 | License'' in the Emacs manual. |
dd8839b0 DL |
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.'' | |
2482f038 DL |
27 | |
28 | This document is part of a collection distributed under the GNU Free | |
29 | Documentation License. If you want to distribute this document | |
30 | separately from the collection, you can do so by adding a copy of the | |
31 | license to the document, as described in section 6 of the license. | |
18f952d5 KB |
32 | @end quotation |
33 | @end copying | |
dd8839b0 | 34 | |
18f952d5 KB |
35 | @dircategory Emacs |
36 | @direntry | |
23f87bed | 37 | * Emacs MIME: (emacs-mime). Emacs MIME de/composition library. |
18f952d5 KB |
38 | @end direntry |
39 | @iftex | |
40 | @finalout | |
41 | @end iftex | |
42 | @setchapternewpage odd | |
dd8839b0 DL |
43 | |
44 | @titlepage | |
45 | @title Emacs MIME Manual | |
46 | ||
47 | @author by Lars Magne Ingebrigtsen | |
48 | @page | |
dd8839b0 | 49 | @vskip 0pt plus 1filll |
18f952d5 | 50 | @insertcopying |
dd8839b0 | 51 | @end titlepage |
dd8839b0 | 52 | |
23f87bed MB |
53 | @node Top |
54 | @top Emacs MIME | |
55 | ||
56 | This manual documents the libraries used to compose and display | |
57 | @acronym{MIME} messages. | |
58 | ||
3d80e1a2 | 59 | This manual is directed at users who want to modify the behavior of |
23f87bed MB |
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. | |
63 | ||
64 | @acronym{MIME} is short for @dfn{Multipurpose Internet Mail Extensions}. | |
65 | This standard is documented in a number of RFCs; mainly RFC2045 (Format | |
66 | of Internet Message Bodies), RFC2046 (Media Types), RFC2047 (Message | |
67 | Header Extensions for Non-@acronym{ASCII} Text), RFC2048 (Registration | |
68 | Procedures), RFC2049 (Conformance Criteria and Examples). It is highly | |
69 | recommended that anyone who intends writing @acronym{MIME}-compliant software | |
70 | read at least RFC2045 and RFC2047. | |
71 | ||
72 | @menu | |
73 | * Decoding and Viewing:: A framework for decoding and viewing. | |
74 | * Composing:: @acronym{MML}; a language for describing @acronym{MIME} parts. | |
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 | ||
85 | This chapter deals with decoding and viewing @acronym{MIME} messages on a | |
86 | higher level. | |
87 | ||
88 | The main idea is to first analyze a @acronym{MIME} article, and then allow | |
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 | |
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. | |
100 | @end menu | |
101 | ||
102 | ||
103 | @node Dissection | |
104 | @section Dissection | |
105 | ||
106 | The @code{mm-dissect-buffer} is the function responsible for dissecting | |
107 | a @acronym{MIME} article. If given a multipart message, it will recursively | |
108 | descend the message, following the structure, and return a tree of | |
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. | |
141 | ||
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 | |
180 | ||
181 | @node Handles | |
182 | @section Handles | |
183 | ||
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: | |
188 | ||
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} | |
193 | part. | |
194 | ||
195 | @item mm-handle-type | |
196 | @findex mm-handle-type | |
197 | Return the parsed @code{Content-Type} of the part. | |
198 | ||
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 | |
206 | has been displayed). | |
207 | ||
208 | @item mm-handle-set-undisplayer | |
209 | @findex mm-handle-set-undisplayer | |
210 | Set the undisplayer object. | |
211 | ||
212 | @item mm-handle-disposition | |
213 | @findex mm-handle-disposition | |
214 | Return the parsed @code{Content-Disposition} of the part. | |
215 | ||
23f87bed MB |
216 | @item mm-get-content-id |
217 | Returns the handle(s) referred to by @code{Content-ID}. | |
218 | ||
219 | @end table | |
220 | ||
221 | ||
222 | @node Display | |
223 | @section Display | |
224 | ||
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. | |
231 | ||
232 | @item mm-remove-part | |
233 | @findex mm-remove-part | |
234 | Remove the part (if it has been displayed). | |
235 | ||
236 | @item mm-inlinable-p | |
237 | @findex mm-inlinable-p | |
238 | Say whether a @acronym{MIME} type can be displayed inline. | |
239 | ||
240 | @item mm-automatic-display-p | |
241 | @findex mm-automatic-display-p | |
242 | Say whether a @acronym{MIME} type should be displayed automatically. | |
243 | ||
244 | @item mm-destroy-part | |
245 | @findex mm-destroy-part | |
246 | Free all resources occupied by a part. | |
247 | ||
248 | @item mm-save-part | |
249 | @findex mm-save-part | |
250 | Offer to save the part in a file. | |
251 | ||
252 | @item mm-pipe-part | |
253 | @findex mm-pipe-part | |
254 | Offer to pipe the part to some process. | |
255 | ||
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 | |
261 | ||
262 | ||
263 | @node Display Customization | |
264 | @section Display Customization | |
265 | ||
266 | @table @code | |
267 | ||
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 | |
271 | is a function to display the part @dfn{inline} (i.e., inside Emacs), and | |
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 | ||
279 | @item mm-inlined-types | |
280 | @vindex mm-inlined-types | |
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 | |
283 | @acronym{MIME} media types. | |
284 | ||
285 | @item mm-automatic-display | |
286 | @vindex mm-automatic-display | |
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. | |
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. | |
295 | ||
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 | |
304 | @samp{attachment}. This variable allows overriding that disposition and | |
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 | ||
308 | @item mm-discouraged-alternatives | |
309 | @vindex mm-discouraged-alternatives | |
310 | List of @acronym{MIME} types that are discouraged when viewing | |
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 | |
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 | ||
3031d8b0 | 325 | Adding @code{"image/.*"} might also be useful. Spammers use it as the |
7dafe00b MB |
326 | prefered part of @samp{multipart/alternative} messages, and you might |
327 | not notice there are other parts. See also | |
3031d8b0 MB |
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. | |
7dafe00b MB |
331 | For example, you can set those variables like: |
332 | ||
333 | @lisp | |
334 | (setq gnus-buttonized-mime-types | |
335 | '("multipart/alternative" "multipart/signed") | |
336 | mm-discouraged-alternatives | |
337 | '("text/html" "image/.*")) | |
338 | @end lisp | |
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 | |
345 | ||
346 | 2. (*) text/plain ( ) text/html | |
347 | @end example | |
3031d8b0 | 348 | |
23f87bed MB |
349 | @item mm-inline-large-images |
350 | @vindex mm-inline-large-images | |
f4dd4ae8 | 351 | When displaying inline images that are larger than the window, Emacs |
23f87bed MB |
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 | ||
360 | @item mm-inline-override-types | |
361 | @vindex mm-inline-override-types | |
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. | |
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 | |
10ace8ea | 410 | Indicate whether external @acronym{MIME} handlers should be used. |
23f87bed | 411 | |
10ace8ea | 412 | If @code{t}, all defined external @acronym{MIME} handlers are used. If |
23f87bed MB |
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 | |
10ace8ea | 418 | attempt is made to use a safe viewer with the safest options---this isn't |
23f87bed MB |
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 | |
428 | ||
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 | |
488 | ||
489 | @node New Viewers | |
490 | @section New Viewers | |
491 | ||
492 | Here's an example viewer for displaying @code{text/enriched} inline: | |
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 | ||
505 | We see that the function takes a @acronym{MIME} handle as its parameter. It | |
506 | then goes to a temporary buffer, inserts the text of the part, does some | |
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 | |
515 | ``undisplayed'' in a convenient manner. | |
516 | ||
517 | ||
518 | @node Composing | |
519 | @chapter Composing | |
520 | @cindex Composing | |
521 | @cindex MIME Composing | |
522 | @cindex MML | |
523 | @cindex MIME Meta Language | |
524 | ||
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. | |
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 | |
533 | string containing the @acronym{MIME} message. | |
534 | ||
535 | @menu | |
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. | |
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 | ||
583 | The @acronym{MML} language is very simple. It looks a bit like an SGML | |
584 | application, but it's not. | |
585 | ||
586 | The main concept of @acronym{MML} is the @dfn{part}. Each part can be of a | |
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 | ||
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 | |
604 | header it will be used in. | |
605 | ||
606 | @table @samp | |
607 | @item type | |
608 | The @acronym{MIME} type of the part (@code{Content-Type}). | |
609 | ||
610 | @item filename | |
611 | Use the contents of the file in the body of the part | |
612 | (@code{Content-Disposition}). | |
613 | ||
614 | @item charset | |
615 | The contents of the body of the part are to be encoded in the character | |
616 | set specified (@code{Content-Type}). @xref{Charset Translation}. | |
617 | ||
618 | @item name | |
619 | Might be used to suggest a file name if the part is to be saved | |
620 | to a file (@code{Content-Type}). | |
621 | ||
622 | @item disposition | |
623 | Valid values are @samp{inline} and @samp{attachment} | |
624 | (@code{Content-Disposition}). | |
625 | ||
626 | @item encoding | |
627 | Valid values are @samp{7bit}, @samp{8bit}, @samp{quoted-printable} and | |
628 | @samp{base64} (@code{Content-Transfer-Encoding}). @xref{Charset | |
629 | Translation}. | |
630 | ||
631 | @item description | |
632 | A description of the part (@code{Content-Description}). | |
633 | ||
634 | @item creation-date | |
635 | RFC822 date when the part was created (@code{Content-Disposition}). | |
636 | ||
637 | @item modification-date | |
638 | RFC822 date when the part was modified (@code{Content-Disposition}). | |
639 | ||
640 | @item read-date | |
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. | |
650 | ||
651 | @item size | |
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}) | |
661 | ||
662 | @end table | |
663 | ||
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 | ||
674 | Parameters for @samp{application/octet-stream}: | |
675 | ||
676 | @table @samp | |
677 | @item type | |
678 | Type of the part; informal---meant for human readers | |
679 | (@code{Content-Type}). | |
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}, | |
688 | @samp{localfile}, and @samp{mailserver}. (@code{Content-Type}.) | |
689 | ||
690 | @item expiration | |
691 | The RFC822 date after which the file may no longer be fetched. | |
692 | (@code{Content-Type}.) | |
693 | ||
694 | @item size | |
695 | The size (in octets) of the file. (@code{Content-Type}.) | |
696 | ||
697 | @item permission | |
698 | Valid values are @samp{read} and @samp{read-write} | |
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. | |
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 | ||
742 | And this is the resulting @acronym{MIME} message: | |
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 | ||
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 | |
3d80e1a2 | 818 | default is |
23f87bed MB |
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 | |
f3f01d5d MB |
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 | |
0683d241 MB |
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 | |
23f87bed MB |
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 | |
0683d241 | 844 | @code{(iso-8859-1)}. You can override this setting on a per-message |
23f87bed MB |
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 | ||
879 | @node Charset Translation | |
880 | @section Charset Translation | |
881 | @cindex charsets | |
882 | ||
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. | |
886 | ||
887 | @vindex mail-parse-charset | |
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 | |
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 | |
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. | |
898 | ||
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 | |
f3f01d5d MB |
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. | |
23f87bed MB |
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. | |
918 | ||
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}). | |
934 | ||
935 | @node Conversion | |
936 | @section Conversion | |
937 | ||
938 | @findex mime-to-mml | |
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. | |
945 | ||
946 | @findex mml-to-mime | |
947 | An @acronym{MML} message can be converted back to @acronym{MIME} by the | |
948 | @code{mml-to-mime} function. | |
949 | ||
950 | These functions are in certain senses ``lossy''---you will not get back | |
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 | |
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, | |
955 | while @code{mml-to-mime} may decide to use quoted-printable encoding, and | |
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. | |
dd8839b0 | 961 | |
dd8839b0 | 962 | |
23f87bed MB |
963 | @node Flowed text |
964 | @section Flowed text | |
965 | @cindex format=flowed | |
dd8839b0 | 966 | |
23f87bed MB |
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}. | |
dd8839b0 | 985 | |
dd8839b0 | 986 | |
dd8839b0 DL |
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 | |
23f87bed | 999 | @code{Content-Type} header that only allows @acronym{ASCII} characters in the |
dd8839b0 | 1000 | parameter list. RFC2231 expands on RFC2045 syntax to provide a scheme |
23f87bed | 1001 | for continuation headers and non-@acronym{ASCII} characters. |
dd8839b0 DL |
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 | ||
23f87bed MB |
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. | |
dd8839b0 DL |
1020 | |
1021 | The following functions are defined by this library: | |
1022 | ||
23f87bed MB |
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: | |
dd8839b0 DL |
1028 | |
1029 | @lisp | |
1030 | ("type/subtype" | |
1031 | (attribute1 . value1) | |
1032 | (attribute2 . value2) | |
23f87bed | 1033 | ...) |
dd8839b0 DL |
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 | ||
23f87bed MB |
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. | |
dd8839b0 | 1048 | |
23f87bed | 1049 | @item mail-content-type-get |
dd8839b0 | 1050 | @findex mail-content-type-get |
23f87bed MB |
1051 | Takes two parameters---a list on the format above, and an attribute. |
1052 | Returns the value of the attribute. | |
dd8839b0 DL |
1053 | |
1054 | @example | |
1055 | (mail-content-type-get | |
1056 | '("image/gif" (name . "b980912.gif")) 'name) | |
1057 | @result{} "b980912.gif" | |
1058 | @end example | |
1059 | ||
23f87bed MB |
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}. | |
dd8839b0 | 1065 | |
23f87bed MB |
1066 | @item mail-header-remove-comments |
1067 | @findex mail-header-remove-comments | |
1068 | Return a comment-free version of a header. | |
dd8839b0 DL |
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 | ||
23f87bed MB |
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. | |
dd8839b0 DL |
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 | ||
23f87bed MB |
1087 | @item mail-header-get-comment |
1088 | @findex mail-header-get-comment | |
1089 | Return the last comment in a header. | |
dd8839b0 DL |
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 | ||
23f87bed MB |
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. | |
dd8839b0 DL |
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 | ||
23f87bed MB |
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. | |
dd8839b0 DL |
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 | ||
23f87bed MB |
1120 | @item mail-header-parse-date |
1121 | @findex mail-header-parse-date | |
1122 | Parse a date string and return an Emacs time structure. | |
dd8839b0 | 1123 | |
23f87bed MB |
1124 | @item mail-narrow-to-head |
1125 | @findex mail-narrow-to-head | |
dd8839b0 DL |
1126 | Narrow the buffer to the header section of the buffer. Point is placed |
1127 | at the beginning of the narrowed buffer. | |
1128 | ||
23f87bed MB |
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. | |
dd8839b0 | 1141 | |
23f87bed MB |
1142 | @item mail-header-field-value |
1143 | @findex mail-header-field-value | |
1144 | Return the value of the field under point. | |
dd8839b0 | 1145 | |
23f87bed MB |
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 |