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