a36c5b0eab3f4a23434e44b53f93241d14fa4177
[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 @sc{mime} messages.
80
81 This manual is directed at users who want to modify the behaviour of
82 the @sc{mime} encoding/decoding process or want a more detailed
83 picture of how the Emacs @sc{mime} library works, and people who want
84 to write functions and commands that manipulate @sc{mime} elements.
85
86 @sc{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-ASCII Text), RFC2048 (Registration
90 Procedures), RFC2049 (Conformance Criteria and Examples).  It is highly
91 recommended that anyone who intends writing @sc{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 @sc{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 @sc{mime} messages on a
108 higher level.
109
110 The main idea is to first analyze a @sc{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 @sc{mime} message.
116 * Non-MIME::               Analyzing a non-@sc{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 @sc{mime} article.  If given a multipart message, it will recursively
130 descend the message, following the structure, and return a tree of
131 @sc{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-@sc{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-@sc{mime} forwarded message.
171
172 @item gnatsweb
173 @findex gnatsweb
174 Gnatsweb attachment.
175
176 @item pgp-signed
177 @findex pgp-signed
178 PGP signed clear text.
179
180 @item pgp-encrypted
181 @findex pgp-encrypted
182 PGP encrypted clear text.
183
184 @item pgp-key
185 @findex pgp-key
186 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 @sc{mime} handle is a list that fully describes a @sc{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 @sc{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 @sc{mime} type can be displayed inline.
265
266 @item mm-automatic-display-p
267 @findex mm-automatic-display-p
268 Say whether a @sc{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 @sc{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 @sc{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 @sc{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 @sc{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 @sc{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 @sc{mime} handle as the argument.
381
382 @item mm-inline-text-html-with-images
383 @vindex mm-inline-text-html-with-images
384 Some @sc{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 @sc{html} email
398 (the default value is @samp{\\`cid:}).  If @code{nil} consider all
399 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 @sc{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 @sc{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 @sc{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 @sc{mime} message is boring and non-trivial.  Therefore, a
503 library called @code{mml} has been defined that parses a language called
504 MML (@sc{mime} Meta Language) and generates @sc{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 @sc{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 @sc{mime}.
517 * Conversion::                     Going from @sc{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 @sc{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 @sc{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 size
624 The size (in octets) of the part (@code{Content-Disposition}).
625
626 @item sign
627 What technology to sign this MML part with (@code{smime}, @code{pgp}
628 or @code{pgpmime})
629
630 @item encrypt
631 What technology to encrypt this MML part with (@code{smime},
632 @code{pgp} or @code{pgpmime})
633
634 @end table
635
636 Parameters for @samp{application/octet-stream}:
637
638 @table @samp
639 @item type
640 Type of the part; informal---meant for human readers
641 (@code{Content-Type}).
642 @end table
643
644 Parameters for @samp{message/external-body}:
645
646 @table @samp
647 @item access-type
648 A word indicating the supported access mechanism by which the file may
649 be obtained.  Values include @samp{ftp}, @samp{anon-ftp}, @samp{tftp},
650 @samp{localfile}, and @samp{mailserver}.  (@code{Content-Type}.)
651
652 @item expiration
653 The RFC822 date after which the file may no longer be fetched.
654 (@code{Content-Type}.)
655
656 @item size
657 The size (in octets) of the file.  (@code{Content-Type}.)
658
659 @item permission
660 Valid values are @samp{read} and @samp{read-write}
661 (@code{Content-Type}).
662
663 @end table
664
665 Parameters for @samp{sign=smime}:
666
667 @table @samp
668
669 @item keyfile
670 File containing key and certificate for signer.
671
672 @end table
673
674 Parameters for @samp{encrypt=smime}:
675
676 @table @samp
677
678 @item certfile
679 File containing certificate for recipient.
680
681 @end table
682
683
684 @node Advanced MML Example
685 @section Advanced MML Example
686
687 Here's a complex multipart message.  It's a @samp{multipart/mixed} that
688 contains many parts, one of which is a @samp{multipart/alternative}.
689
690 @example
691 <#multipart type=mixed>
692 <#part type=image/jpeg filename=~/rms.jpg disposition=inline>
693 <#multipart type=alternative>
694 This is a plain text part.
695 <#part type=text/enriched name=enriched.txt>
696 <center>This is a centered enriched part</center>
697 <#/multipart>
698 This is a new plain text part.
699 <#part disposition=attachment>
700 This plain text part is an attachment.
701 <#/multipart>
702 @end example
703
704 And this is the resulting @sc{mime} message:
705
706 @example
707 Content-Type: multipart/mixed; boundary="=-=-="
708
709
710 --=-=-=
711
712
713
714 --=-=-=
715 Content-Type: image/jpeg;
716  filename="~/rms.jpg"
717 Content-Disposition: inline;
718  filename="~/rms.jpg"
719 Content-Transfer-Encoding: base64
720
721 /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRof
722 Hh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCAAwADABAREA/8QAHwAA
723 AQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQR
724 BRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RF
725 RkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ip
726 qrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEB
727 AAA/AO/rifFHjldNuGsrDa0qcSSHkA+gHrXKw+LtWLrMb+RgTyhbr+HSug07xNqV9fQtZrNI
728 AyiaE/NuBPOOOP0rvRNE880KOC8TbXXGCv1FPqjrF4LDR7u5L7SkTFT/ALWOP1xXgTuXfc7E
729 sx6nua6rwp4IvvEM8chCxWxOdzn7wz6V9AaB4S07w9p5itow0rDLSY5Pt9K43xO66P4xs71m
730 2QXiGCbA4yOVJ9+1aYORkdK434lyNH4ahCnG66VT9Nj15JFbPdX0MS43M4VQf5/yr2vSpLnw
731 5ZW8dlCZ8KFXjOPX0/mK6rSPEGt3Angu44fNEReHYNvIH3TzXDeKNO8RX+kSX2ouZkicTIOc
732 L+g7E810ulFjpVtv3bwgB3HJyK5L4quY/C9sVxk3ij/xx6850u7t1mtp/wDlpEw3An3Jr3Dw
733 34gsbWza4nBlhC5LDsaW6+IFgupQyCF3iHH7gA7c9R9ay7zx6t7aX9jHC4smhfBkGCvHGfrm
734 tLQ7hbnRrV1GPkAP1x1/Hr+Ncr8Vzjwrbf8AX6v/AKA9eQRyYlQk8Yx9K6XTNbkgia2ciSIn
735 7p5Ga9Atte0LTLKO6it4i7dVRFJDcZ4PvXN+JvEMF9bILVGXJLSZ4zkjivRPDaeX4b08HOTC
736 pOffmua+KkbS+GLVUGT9tT/0B68eeIpIFYjB70+OOVXyoOM9+M1eaWeCLzHPyHGO/NVWvJJm
737 jQ8KGH1NfQWhXSXmh2c8eArRLwO3HSv/2Q==
738
739 --=-=-=
740 Content-Type: multipart/alternative; boundary="==-=-="
741
742
743 --==-=-=
744
745
746 This is a plain text part.
747
748 --==-=-=
749 Content-Type: text/enriched;
750  name="enriched.txt"
751
752
753 <center>This is a centered enriched part</center>
754
755 --==-=-=--
756
757 --=-=-=
758
759 This is a new plain text part.
760
761 --=-=-=
762 Content-Disposition: attachment
763
764
765 This plain text part is an attachment.
766
767 --=-=-=--
768 @end example
769
770 @node Encoding Customization
771 @section Encoding Customization
772
773 @table @code
774
775 @item mm-body-charset-encoding-alist
776 @vindex mm-body-charset-encoding-alist
777 Mapping from @sc{mime} charset to encoding to use.  This variable is
778 usually used except, e.g., when other requirements force a specific
779 encoding (digitally signed messages require 7bit encodings).  The
780 default is 
781
782 @lisp
783 ((iso-2022-jp . 7bit)
784  (iso-2022-jp-2 . 7bit)
785  (utf-16 . base64)
786  (utf-16be . base64)
787  (utf-16le . base64))
788 @end lisp
789
790 As an example, if you do not want to have ISO-8859-1 characters
791 quoted-printable encoded, you may add @code{(iso-8859-1 . 8bit)} to
792 this variable.  You can override this setting on a per-message basis
793 by using the @code{encoding} MML tag (@pxref{MML Definition}).
794
795 @item mm-coding-system-priorities
796 @vindex mm-coding-system-priorities
797 Prioritize coding systems to use for outgoing messages.  The default
798 is @code{nil}, which means to use the defaults in Emacs.  It is a list of
799 coding system symbols (aliases of coding systems does not work, use
800 @kbd{M-x describe-coding-system} to make sure you are not specifying
801 an alias in this variable).  For example, if you have configured Emacs
802 to use prefer UTF-8, but wish that outgoing messages should be sent in
803 ISO-8859-1 if possible, you can set this variable to
804 @code{(iso-latin-1)}. You can override this setting on a per-message
805 basis by using the @code{charset} MML tag (@pxref{MML Definition}).
806
807 @item mm-content-transfer-encoding-defaults
808 @vindex mm-content-transfer-encoding-defaults
809 Mapping from @sc{mime} types to encoding to use.  This variable is usually
810 used except, e.g., when other requirements force a safer encoding
811 (digitally signed messages require 7bit encoding). Besides the normal
812 @sc{mime} encodings, @code{qp-or-base64} may be used to indicate that for
813 each case the most efficient of quoted-printable and base64 should be
814 used.  You can override this setting on a per-message basis by using
815 the @code{encoding} MML tag (@pxref{MML Definition}).
816
817 @item mm-use-ultra-safe-encoding
818 @vindex mm-use-ultra-safe-encoding
819 When this is non-@code{nil}, it means that textual parts are encoded as
820 quoted-printable if they contain lines longer than 76 characters or
821 starting with "From " in the body.  Non-7bit encodings (8bit, binary)
822 are generally disallowed.  This reduce the probability that a non-8bit
823 clean MTA or MDA changes the message.  This should never be set
824 directly, but bound by other functions when necessary (e.g., when
825 encoding messages that are to be digitally signed).
826
827 @end table
828
829 @node Charset Translation
830 @section Charset Translation
831 @cindex charsets
832
833 During translation from MML to @sc{mime}, for each @sc{mime} part which
834 has been composed inside Emacs, an appropriate charset has to be chosen.
835
836 @vindex mail-parse-charset
837 If you are running a non-@sc{mule} Emacs, this process is simple: If the
838 part contains any non-ASCII (8-bit) characters, the @sc{mime} charset
839 given by @code{mail-parse-charset} (a symbol) is used.  (Never set this
840 variable directly, though.  If you want to change the default charset,
841 please consult the documentation of the package which you use to process
842 @sc{mime} messages.
843 @xref{Various Message Variables, , Various Message Variables, message,
844       Message Manual}, for example.)
845 If there are only ASCII characters, the @sc{mime} charset US-ASCII is
846 used, of course.
847
848 @cindex MULE
849 @cindex UTF-8
850 @cindex Unicode
851 @vindex mm-mime-mule-charset-alist
852 Things are slightly more complicated when running Emacs with @sc{mule}
853 support.  In this case, a list of the @sc{mule} charsets used in the
854 part is obtained, and the @sc{mule} charsets are translated to @sc{mime}
855 charsets by consulting the variable @code{mm-mime-mule-charset-alist}.
856 If this results in a single @sc{mime} charset, this is used to encode
857 the part.  But if the resulting list of @sc{mime} charsets contains more
858 than one element, two things can happen: If it is possible to encode the
859 part via UTF-8, this charset is used.  (For this, Emacs must support
860 the @code{utf-8} coding system, and the part must consist entirely of
861 characters which have Unicode counterparts.)  If UTF-8 is not available
862 for some reason, the part is split into several ones, so that each one
863 can be encoded with a single @sc{mime} charset.  The part can only be
864 split at line boundaries, though---if more than one @sc{mime} charset is
865 required to encode a single line, it is not possible to encode the part.
866
867 When running Emacs with @sc{mule} support, the preferences for which
868 coding system to use is inherited from Emacs itself.  This means that
869 if Emacs is set up to prefer UTF-8, it will be used when encoding
870 messages.  You can modify this by altering the
871 @code{mm-coding-system-priorities} variable though (@pxref{Encoding
872 Customization}).
873
874 The charset to be used can be overriden by setting the @code{charset}
875 MML tag (@pxref{MML Definition}) when composing the message.
876
877 The encoding of characters (quoted-printable, 8bit etc) is orthogonal
878 to the discussion here, and is controlled by the variables
879 @code{mm-body-charset-encoding-alist} and
880 @code{mm-content-transfer-encoding-defaults} (@pxref{Encoding
881 Customization}).
882
883 @node Conversion
884 @section Conversion
885
886 @findex mime-to-mml
887 A (multipart) @sc{mime} message can be converted to MML with the
888 @code{mime-to-mml} function.  It works on the message in the current
889 buffer, and substitutes MML markup for @sc{mime} boundaries.
890 Non-textual parts do not have their contents in the buffer, but instead
891 have the contents in separate buffers that are referred to from the MML
892 tags.
893
894 @findex mml-to-mime
895 An MML message can be converted back to @sc{mime} by the
896 @code{mml-to-mime} function.
897
898 These functions are in certain senses ``lossy''---you will not get back
899 an identical message if you run @sc{mime-to-mml} and then
900 @sc{mml-to-mime}.  Not only will trivial things like the order of the
901 headers differ, but the contents of the headers may also be different.
902 For instance, the original message may use base64 encoding on text,
903 while @sc{mml-to-mime} may decide to use quoted-printable encoding, and
904 so on.
905
906 In essence, however, these two functions should be the inverse of each
907 other.  The resulting contents of the message should remain equivalent,
908 if not identical.
909
910
911 @node Flowed text
912 @section Flowed text
913 @cindex format=flowed
914
915 The Emacs @sc{mime} library will respect the @code{use-hard-newlines}
916 variable (@pxref{Hard and Soft Newlines, ,Hard and Soft Newlines,
917 emacs, Emacs Manual}) when encoding a message, and the
918 ``format=flowed'' Content-Type parameter when decoding a message.
919
920 On encoding text, lines terminated by soft newline characters are
921 filled together and wrapped after the column decided by
922 @code{fill-flowed-encode-column}.  This variable controls how the text
923 will look in a client that does not support flowed text, the default
924 is to wrap after 66 characters.  If hard newline characters are not
925 present in the buffer, no flow encoding occurs.
926
927 On decoding flowed text, lines with soft newline characters are filled
928 together and wrapped after the column decided by
929 @code{fill-flowed-display-column}.  The default is to wrap after
930 @code{fill-column}.
931
932
933
934
935 @node Interface Functions
936 @chapter Interface Functions
937 @cindex interface functions
938 @cindex mail-parse
939
940 The @code{mail-parse} library is an abstraction over the actual
941 low-level libraries that are described in the next chapter.
942
943 Standards change, and so programs have to change to fit in the new
944 mold.  For instance, RFC2045 describes a syntax for the
945 @code{Content-Type} header that only allows ASCII characters in the
946 parameter list.  RFC2231 expands on RFC2045 syntax to provide a scheme
947 for continuation headers and non-ASCII characters.
948
949 The traditional way to deal with this is just to update the library
950 functions to parse the new syntax.  However, this is sometimes the wrong
951 thing to do.  In some instances it may be vital to be able to understand
952 both the old syntax as well as the new syntax, and if there is only one
953 library, one must choose between the old version of the library and the
954 new version of the library.
955
956 The Emacs @sc{mime} library takes a different tack.  It defines a
957 series of low-level libraries (@file{rfc2047.el}, @file{rfc2231.el}
958 and so on) that parses strictly according to the corresponding
959 standard.  However, normal programs would not use the functions
960 provided by these libraries directly, but instead use the functions
961 provided by the @code{mail-parse} library.  The functions in this
962 library are just aliases to the corresponding functions in the latest
963 low-level libraries.  Using this scheme, programs get a consistent
964 interface they can use, and library developers are free to create
965 write code that handles new standards.
966
967 The following functions are defined by this library:
968
969 @table @code
970 @item mail-header-parse-content-type
971 @findex mail-header-parse-content-type
972 Parse a @code{Content-Type} header and return a list on the following
973 format:
974
975 @lisp
976 ("type/subtype"
977  (attribute1 . value1)
978  (attribute2 . value2)
979  ...)
980 @end lisp
981
982 Here's an example:
983
984 @example
985 (mail-header-parse-content-type
986  "image/gif; name=\"b980912.gif\"")
987 @result{} ("image/gif" (name . "b980912.gif"))
988 @end example
989
990 @item mail-header-parse-content-disposition
991 @findex mail-header-parse-content-disposition
992 Parse a @code{Content-Disposition} header and return a list on the same
993 format as the function above.
994
995 @item mail-content-type-get
996 @findex mail-content-type-get
997 Takes two parameters---a list on the format above, and an attribute.
998 Returns the value of the attribute.
999
1000 @example
1001 (mail-content-type-get
1002  '("image/gif" (name . "b980912.gif")) 'name)
1003 @result{} "b980912.gif"
1004 @end example
1005
1006 @item mail-header-encode-parameter
1007 @findex mail-header-encode-parameter
1008 Takes a parameter string and returns an encoded version of the string.
1009 This is used for parameters in headers like @code{Content-Type} and
1010 @code{Content-Disposition}.
1011
1012 @item mail-header-remove-comments
1013 @findex mail-header-remove-comments
1014 Return a comment-free version of a header.
1015
1016 @example
1017 (mail-header-remove-comments
1018  "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)")
1019 @result{} "Gnus/5.070027  "
1020 @end example
1021
1022 @item mail-header-remove-whitespace
1023 @findex mail-header-remove-whitespace
1024 Remove linear white space from a header.  Space inside quoted strings
1025 and comments is preserved.
1026
1027 @example
1028 (mail-header-remove-whitespace
1029  "image/gif; name=\"Name with spaces\"")
1030 @result{} "image/gif;name=\"Name with spaces\""
1031 @end example
1032
1033 @item mail-header-get-comment
1034 @findex mail-header-get-comment
1035 Return the last comment in a header.
1036
1037 @example
1038 (mail-header-get-comment
1039  "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)")
1040 @result{} "Finnish Landrace"
1041 @end example
1042
1043 @item mail-header-parse-address
1044 @findex mail-header-parse-address
1045 Parse an address and return a list containing the mailbox and the
1046 plaintext name.
1047
1048 @example
1049 (mail-header-parse-address
1050  "Hrvoje Niksic <hniksic@@srce.hr>")
1051 @result{} ("hniksic@@srce.hr" . "Hrvoje Niksic")
1052 @end example
1053
1054 @item mail-header-parse-addresses
1055 @findex mail-header-parse-addresses
1056 Parse a string with list of addresses and return a list of elements like
1057 the one described above.
1058
1059 @example
1060 (mail-header-parse-addresses
1061  "Hrvoje Niksic <hniksic@@srce.hr>, Steinar Bang <sb@@metis.no>")
1062 @result{} (("hniksic@@srce.hr" . "Hrvoje Niksic")
1063      ("sb@@metis.no" . "Steinar Bang"))
1064 @end example
1065
1066 @item mail-header-parse-date
1067 @findex mail-header-parse-date
1068 Parse a date string and return an Emacs time structure.
1069
1070 @item mail-narrow-to-head
1071 @findex mail-narrow-to-head
1072 Narrow the buffer to the header section of the buffer.  Point is placed
1073 at the beginning of the narrowed buffer.
1074
1075 @item mail-header-narrow-to-field
1076 @findex mail-header-narrow-to-field
1077 Narrow the buffer to the header under point.  Understands continuation
1078 headers.
1079
1080 @item mail-header-fold-field
1081 @findex mail-header-fold-field
1082 Fold the header under point.
1083
1084 @item mail-header-unfold-field
1085 @findex mail-header-unfold-field
1086 Unfold the header under point.
1087
1088 @item mail-header-field-value
1089 @findex mail-header-field-value
1090 Return the value of the field under point.
1091
1092 @item mail-encode-encoded-word-region
1093 @findex mail-encode-encoded-word-region
1094 Encode the non-ASCII words in the region.  For instance,
1095 @samp{Naïve} is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}.
1096
1097 @item mail-encode-encoded-word-buffer
1098 @findex mail-encode-encoded-word-buffer
1099 Encode the non-ASCII words in the current buffer.  This function is
1100 meant to be called narrowed to the headers of a message.
1101
1102 @item mail-encode-encoded-word-string
1103 @findex mail-encode-encoded-word-string
1104 Encode the words that need encoding in a string, and return the result.
1105
1106 @example
1107 (mail-encode-encoded-word-string
1108  "This is naïve, baby")
1109 @result{} "This is =?iso-8859-1?q?na=EFve,?= baby"
1110 @end example
1111
1112 @item mail-decode-encoded-word-region
1113 @findex mail-decode-encoded-word-region
1114 Decode the encoded words in the region.
1115
1116 @item mail-decode-encoded-word-string
1117 @findex mail-decode-encoded-word-string
1118 Decode the encoded words in the string and return the result.
1119
1120 @example
1121 (mail-decode-encoded-word-string
1122  "This is =?iso-8859-1?q?na=EFve,?= baby")
1123 @result{} "This is naïve, baby"
1124 @end example
1125
1126 @end table
1127
1128 Currently, @code{mail-parse} is an abstraction over @code{ietf-drums},
1129 @code{rfc2047}, @code{rfc2045} and @code{rfc2231}.  These are documented
1130 in the subsequent sections.
1131
1132
1133
1134 @node Basic Functions
1135 @chapter Basic Functions
1136
1137 This chapter describes the basic, ground-level functions for parsing and
1138 handling.  Covered here is parsing @code{From} lines, removing comments
1139 from header lines, decoding encoded words, parsing date headers and so
1140 on.  High-level functionality is dealt with in the next chapter
1141 (@pxref{Decoding and Viewing}).
1142
1143 @menu
1144 * rfc2045::      Encoding @code{Content-Type} headers.
1145 * rfc2231::      Parsing @code{Content-Type} headers.
1146 * ietf-drums::   Handling mail headers defined by RFC822bis.
1147 * rfc2047::      En/decoding encoded words in headers.
1148 * time-date::    Functions for parsing dates and manipulating time.
1149 * qp::           Quoted-Printable en/decoding.
1150 * base64::       Base64 en/decoding.
1151 * binhex::       Binhex decoding.
1152 * uudecode::     Uuencode decoding.
1153 * yenc::         Yenc decoding.
1154 * rfc1843::      Decoding HZ-encoded text.
1155 * mailcap::      How parts are displayed is specified by the @file{.mailcap} file
1156 @end menu
1157
1158
1159 @node rfc2045
1160 @section rfc2045
1161
1162 RFC2045 is the ``main'' @sc{mime} document, and as such, one would
1163 imagine that there would be a lot to implement.  But there isn't, since
1164 most of the implementation details are delegated to the subsequent
1165 RFCs.
1166
1167 So @file{rfc2045.el} has only a single function:
1168
1169 @table @code
1170 @item rfc2045-encode-string
1171 @findex rfc2045-encode-string
1172 Takes a parameter and a value and returns a @samp{PARAM=VALUE} string.
1173 @var{value} will be quoted if there are non-safe characters in it.
1174 @end table
1175
1176
1177 @node rfc2231
1178 @section rfc2231
1179
1180 RFC2231 defines a syntax for the @code{Content-Type} and
1181 @code{Content-Disposition} headers.  Its snappy name is @dfn{MIME
1182 Parameter Value and Encoded Word Extensions: Character Sets, Languages,
1183 and Continuations}.
1184
1185 In short, these headers look something like this:
1186
1187 @example
1188 Content-Type: application/x-stuff;
1189  title*0*=us-ascii'en'This%20is%20even%20more%20;
1190  title*1*=%2A%2A%2Afun%2A%2A%2A%20;
1191  title*2="isn't it!"
1192 @end example
1193
1194 They usually aren't this bad, though.
1195
1196 The following functions are defined by this library:
1197
1198 @table @code
1199 @item rfc2231-parse-string
1200 @findex rfc2231-parse-string
1201 Parse a @code{Content-Type} header and return a list describing its
1202 elements.
1203
1204 @example
1205 (rfc2231-parse-string
1206  "application/x-stuff;
1207  title*0*=us-ascii'en'This%20is%20even%20more%20;
1208  title*1*=%2A%2A%2Afun%2A%2A%2A%20;
1209  title*2=\"isn't it!\"")
1210 @result{} ("application/x-stuff"
1211     (title . "This is even more ***fun*** isn't it!"))
1212 @end example
1213
1214 @item rfc2231-get-value
1215 @findex rfc2231-get-value
1216 Takes one of the lists on the format above and returns
1217 the value of the specified attribute.
1218
1219 @item rfc2231-encode-string
1220 @findex rfc2231-encode-string
1221 Encode a parameter in headers likes @code{Content-Type} and
1222 @code{Content-Disposition}.
1223
1224 @end table
1225
1226
1227 @node ietf-drums
1228 @section ietf-drums
1229
1230 @dfn{drums} is an IETF working group that is working on the replacement
1231 for RFC822.
1232
1233 The functions provided by this library include:
1234
1235 @table @code
1236 @item ietf-drums-remove-comments
1237 @findex ietf-drums-remove-comments
1238 Remove the comments from the argument and return the results.
1239
1240 @item ietf-drums-remove-whitespace
1241 @findex ietf-drums-remove-whitespace
1242 Remove linear white space from the string and return the results.
1243 Spaces inside quoted strings and comments are left untouched.
1244
1245 @item ietf-drums-get-comment
1246 @findex ietf-drums-get-comment
1247 Return the last most comment from the string.
1248
1249 @item ietf-drums-parse-address
1250 @findex ietf-drums-parse-address
1251 Parse an address string and return a list that contains the mailbox and
1252 the plain text name.
1253
1254 @item ietf-drums-parse-addresses
1255 @findex ietf-drums-parse-addresses
1256 Parse a string that contains any number of comma-separated addresses and
1257 return a list that contains mailbox/plain text pairs.
1258
1259 @item ietf-drums-parse-date
1260 @findex ietf-drums-parse-date
1261 Parse a date string and return an Emacs time structure.
1262
1263 @item ietf-drums-narrow-to-header
1264 @findex ietf-drums-narrow-to-header
1265 Narrow the buffer to the header section of the current buffer.
1266
1267 @end table
1268
1269
1270 @node rfc2047
1271 @section rfc2047
1272
1273 RFC2047 (Message Header Extensions for Non-ASCII Text) specifies how
1274 non-ASCII text in headers are to be encoded.  This is actually rather
1275 complicated, so a number of variables are necessary to tweak what this
1276 library does.
1277
1278 The following variables are tweakable:
1279
1280 @table @code
1281 @item rfc2047-default-charset
1282 @vindex rfc2047-default-charset
1283 Characters in this charset should not be decoded by this library.
1284 This defaults to @code{iso-8859-1}.
1285
1286 @item rfc2047-header-encoding-alist
1287 @vindex rfc2047-header-encoding-alist
1288 This is an alist of header / encoding-type pairs.  Its main purpose is
1289 to prevent encoding of certain headers.
1290
1291 The keys can either be header regexps, or @code{t}.
1292
1293 The values can be either @code{nil}, in which case the header(s) in
1294 question won't be encoded, or @code{mime}, which means that they will be
1295 encoded.
1296
1297 @item rfc2047-charset-encoding-alist
1298 @vindex rfc2047-charset-encoding-alist
1299 RFC2047 specifies two forms of encoding---@code{Q} (a
1300 Quoted-Printable-like encoding) and @code{B} (base64).  This alist
1301 specifies which charset should use which encoding.
1302
1303 @item rfc2047-encoding-function-alist
1304 @vindex rfc2047-encoding-function-alist
1305 This is an alist of encoding / function pairs.  The encodings are
1306 @code{Q}, @code{B} and @code{nil}.
1307
1308 @item rfc2047-q-encoding-alist
1309 @vindex rfc2047-q-encoding-alist
1310 The @code{Q} encoding isn't quite the same for all headers.  Some
1311 headers allow a narrower range of characters, and that is what this
1312 variable is for.  It's an alist of header regexps / allowable character
1313 ranges.
1314
1315 @item rfc2047-encoded-word-regexp
1316 @vindex rfc2047-encoded-word-regexp
1317 When decoding words, this library looks for matches to this regexp.
1318
1319 @end table
1320
1321 Those were the variables, and these are this functions:
1322
1323 @table @code
1324 @item rfc2047-narrow-to-field
1325 @findex rfc2047-narrow-to-field
1326 Narrow the buffer to the header on the current line.
1327
1328 @item rfc2047-encode-message-header
1329 @findex rfc2047-encode-message-header
1330 Should be called narrowed to the header of a message.  Encodes according
1331 to @code{rfc2047-header-encoding-alist}.
1332
1333 @item rfc2047-encode-region
1334 @findex rfc2047-encode-region
1335 Encodes all encodable words in the region specified.
1336
1337 @item rfc2047-encode-string
1338 @findex rfc2047-encode-string
1339 Encode a string and return the results.
1340
1341 @item rfc2047-decode-region
1342 @findex rfc2047-decode-region
1343 Decode the encoded words in the region.
1344
1345 @item rfc2047-decode-string
1346 @findex rfc2047-decode-string
1347 Decode a string and return the results.
1348
1349 @end table
1350
1351
1352 @node time-date
1353 @section time-date
1354
1355 While not really a part of the @sc{mime} library, it is convenient to
1356 document this library here.  It deals with parsing @code{Date} headers
1357 and manipulating time.  (Not by using tesseracts, though, I'm sorry to
1358 say.)
1359
1360 These functions convert between five formats: A date string, an Emacs
1361 time structure, a decoded time list, a second number, and a day number.
1362
1363 Here's a bunch of time/date/second/day examples:
1364
1365 @example
1366 (parse-time-string "Sat Sep 12 12:21:54 1998 +0200")
1367 @result{} (54 21 12 12 9 1998 6 nil 7200)
1368
1369 (date-to-time "Sat Sep 12 12:21:54 1998 +0200")
1370 @result{} (13818 19266)
1371
1372 (time-to-seconds '(13818 19266))
1373 @result{} 905595714.0
1374
1375 (seconds-to-time 905595714.0)
1376 @result{} (13818 19266 0)
1377
1378 (time-to-days '(13818 19266))
1379 @result{} 729644
1380
1381 (days-to-time 729644)
1382 @result{} (961933 65536)
1383
1384 (time-since '(13818 19266))
1385 @result{} (0 430)
1386
1387 (time-less-p '(13818 19266) '(13818 19145))
1388 @result{} nil
1389
1390 (subtract-time '(13818 19266) '(13818 19145))
1391 @result{} (0 121)
1392
1393 (days-between "Sat Sep 12 12:21:54 1998 +0200"
1394               "Sat Sep 07 12:21:54 1998 +0200")
1395 @result{} 5
1396
1397 (date-leap-year-p 2000)
1398 @result{} t
1399
1400 (time-to-day-in-year '(13818 19266))
1401 @result{} 255
1402
1403 (time-to-number-of-days
1404  (time-since
1405   (date-to-time "Mon, 01 Jan 2001 02:22:26 GMT")))
1406 @result{} 4.146122685185185
1407 @end example
1408
1409 And finally, we have @code{safe-date-to-time}, which does the same as
1410 @code{date-to-time}, but returns a zero time if the date is
1411 syntactically malformed.
1412
1413 The five data representations used are the following:
1414
1415 @table @var
1416 @item date
1417 An RFC822 (or similar) date string.  For instance: @code{"Sat Sep 12
1418 12:21:54 1998 +0200"}.
1419
1420 @item time
1421 An internal Emacs time.  For instance: @code{(13818 26466)}.
1422
1423 @item seconds
1424 A floating point representation of the internal Emacs time.  For
1425 instance: @code{905595714.0}.
1426
1427 @item days
1428 An integer number representing the number of days since 00000101.  For
1429 instance: @code{729644}.
1430
1431 @item decoded time
1432 A list of decoded time.  For instance: @code{(54 21 12 12 9 1998 6 t
1433 7200)}.
1434 @end table
1435
1436 All the examples above represent the same moment.
1437
1438 These are the functions available:
1439
1440 @table @code
1441 @item date-to-time
1442 Take a date and return a time.
1443
1444 @item time-to-seconds
1445 Take a time and return seconds.
1446
1447 @item seconds-to-time
1448 Take seconds and return a time.
1449
1450 @item time-to-days
1451 Take a time and return days.
1452
1453 @item days-to-time
1454 Take days and return a time.
1455
1456 @item date-to-day
1457 Take a date and return days.
1458
1459 @item time-to-number-of-days
1460 Take a time and return the number of days that represents.
1461
1462 @item safe-date-to-time
1463 Take a date and return a time.  If the date is not syntactically valid,
1464 return a ``zero'' date.
1465
1466 @item time-less-p
1467 Take two times and say whether the first time is less (i. e., earlier)
1468 than the second time.
1469
1470 @item time-since
1471 Take a time and return a time saying how long it was since that time.
1472
1473 @item subtract-time
1474 Take two times and subtract the second from the first.  I. e., return
1475 the time between the two times.
1476
1477 @item days-between
1478 Take two days and return the number of days between those two days.
1479
1480 @item date-leap-year-p
1481 Take a year number and say whether it's a leap year.
1482
1483 @item time-to-day-in-year
1484 Take a time and return the day number within the year that the time is
1485 in.
1486
1487 @end table
1488
1489
1490 @node qp
1491 @section qp
1492
1493 This library deals with decoding and encoding Quoted-Printable text.
1494
1495 Very briefly explained, qp encoding means translating all 8-bit
1496 characters (and lots of control characters) into things that look like
1497 @samp{=EF}; that is, an equal sign followed by the byte encoded as a hex
1498 string.
1499
1500 The following functions are defined by the library:
1501
1502 @table @code
1503 @item quoted-printable-decode-region
1504 @findex quoted-printable-decode-region
1505 QP-decode all the encoded text in the specified region.
1506
1507 @item quoted-printable-decode-string
1508 @findex quoted-printable-decode-string
1509 Decode the QP-encoded text in a string and return the results.
1510
1511 @item quoted-printable-encode-region
1512 @findex quoted-printable-encode-region
1513 QP-encode all the encodable characters in the specified region.  The third
1514 optional parameter @var{fold} specifies whether to fold long lines.
1515 (Long here means 72.)
1516
1517 @item quoted-printable-encode-string
1518 @findex quoted-printable-encode-string
1519 QP-encode all the encodable characters in a string and return the
1520 results.
1521
1522 @end table
1523
1524
1525 @node base64
1526 @section base64
1527 @cindex base64
1528
1529 Base64 is an encoding that encodes three bytes into four characters,
1530 thereby increasing the size by about 33%.  The alphabet used for
1531 encoding is very resistant to mangling during transit.
1532
1533 The following functions are defined by this library:
1534
1535 @table @code
1536 @item base64-encode-region
1537 @findex base64-encode-region
1538 base64 encode the selected region.  Return the length of the encoded
1539 text.  Optional third argument @var{no-line-break} means do not break
1540 long lines into shorter lines.
1541
1542 @item base64-encode-string
1543 @findex base64-encode-string
1544 base64 encode a string and return the result.
1545
1546 @item base64-decode-region
1547 @findex base64-decode-region
1548 base64 decode the selected region.  Return the length of the decoded
1549 text.  If the region can't be decoded, return @code{nil} and don't
1550 modify the buffer.
1551
1552 @item base64-decode-string
1553 @findex base64-decode-string
1554 base64 decode a string and return the result.  If the string can't be
1555 decoded, @code{nil} is returned.
1556
1557 @end table
1558
1559
1560 @node binhex
1561 @section binhex
1562 @cindex binhex
1563 @cindex Apple
1564 @cindex Macintosh
1565
1566 @code{binhex} is an encoding that originated in Macintosh environments.
1567 The following function is supplied to deal with these:
1568
1569 @table @code
1570 @item binhex-decode-region
1571 @findex binhex-decode-region
1572 Decode the encoded text in the region.  If given a third parameter, only
1573 decode the @code{binhex} header and return the filename.
1574
1575 @end table
1576
1577 @node uudecode
1578 @section uudecode
1579 @cindex uuencode
1580 @cindex uudecode
1581
1582 @code{uuencode} is probably still the most popular encoding of binaries
1583 used on Usenet, although @code{base64} rules the mail world.
1584
1585 The following function is supplied by this package:
1586
1587 @table @code
1588 @item uudecode-decode-region
1589 @findex uudecode-decode-region
1590 Decode the text in the region.
1591 @end table
1592
1593
1594 @node yenc
1595 @section yenc
1596 @cindex yenc
1597
1598 @code{yenc} is used for encoding binaries on Usenet.  The following
1599 function is supplied by this package:
1600
1601 @table @code
1602 @item yenc-decode-region
1603 @findex yenc-decode-region
1604 Decode the encoded text in the region.
1605
1606 @end table
1607
1608
1609 @node rfc1843
1610 @section rfc1843
1611 @cindex rfc1843
1612 @cindex HZ
1613 @cindex Chinese
1614
1615 RFC1843 deals with mixing Chinese and ASCII characters in messages.  In
1616 essence, RFC1843 switches between ASCII and Chinese by doing this:
1617
1618 @example
1619 This sentence is in ASCII.
1620 The next sentence is in GB.~@{<:Ky2;S@{#,NpJ)l6HK!#~@}Bye.
1621 @end example
1622
1623 Simple enough, and widely used in China.
1624
1625 The following functions are available to handle this encoding:
1626
1627 @table @code
1628 @item rfc1843-decode-region
1629 Decode HZ-encoded text in the region.
1630
1631 @item rfc1843-decode-string
1632 Decode a HZ-encoded string and return the result.
1633
1634 @end table
1635
1636
1637 @node mailcap
1638 @section mailcap
1639
1640 The @file{~/.mailcap} file is parsed by most @sc{mime}-aware message
1641 handlers and describes how elements are supposed to be displayed.
1642 Here's an example file:
1643
1644 @example
1645 image/*; gimp -8 %s
1646 audio/wav; wavplayer %s
1647 application/msword; catdoc %s ; copiousoutput ; nametemplate=%s.doc
1648 @end example
1649
1650 This says that all image files should be displayed with @code{gimp},
1651 that WAVE audio files should be played by @code{wavplayer}, and that
1652 MS-WORD files should be inlined by @code{catdoc}.
1653
1654 The @code{mailcap} library parses this file, and provides functions for
1655 matching types.
1656
1657 @table @code
1658 @item mailcap-mime-data
1659 @vindex mailcap-mime-data
1660 This variable is an alist of alists containing backup viewing rules.
1661
1662 @end table
1663
1664 Interface functions:
1665
1666 @table @code
1667 @item mailcap-parse-mailcaps
1668 @findex mailcap-parse-mailcaps
1669 Parse the @file{~/.mailcap} file.
1670
1671 @item mailcap-mime-info
1672 Takes a @sc{mime} type as its argument and returns the matching viewer.
1673
1674 @end table
1675
1676
1677
1678
1679 @node Standards
1680 @chapter Standards
1681
1682 The Emacs @sc{mime} library implements handling of various elements
1683 according to a (somewhat) large number of RFCs, drafts and standards
1684 documents.  This chapter lists the relevant ones.  They can all be
1685 fetched from @uref{http://quimby.gnus.org/notes/}.
1686
1687 @table @dfn
1688 @item RFC822
1689 @itemx STD11
1690 Standard for the Format of ARPA Internet Text Messages.
1691
1692 @item RFC1036
1693 Standard for Interchange of USENET Messages
1694
1695 @item RFC2045
1696 Format of Internet Message Bodies
1697
1698 @item RFC2046
1699 Media Types
1700
1701 @item RFC2047
1702 Message Header Extensions for Non-ASCII Text
1703
1704 @item RFC2048
1705 Registration Procedures
1706
1707 @item RFC2049
1708 Conformance Criteria and Examples
1709
1710 @item RFC2231
1711 @sc{mime} Parameter Value and Encoded Word Extensions: Character Sets,
1712 Languages, and Continuations
1713
1714 @item RFC1843
1715 HZ - A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and
1716 ASCII characters
1717
1718 @item draft-ietf-drums-msg-fmt-05.txt
1719 Draft for the successor of RFC822
1720
1721 @item RFC2112
1722 The @sc{mime} Multipart/Related Content-type
1723
1724 @item RFC1892
1725 The Multipart/Report Content Type for the Reporting of Mail System
1726 Administrative Messages
1727
1728 @item RFC2183
1729 Communicating Presentation Information in Internet Messages: The
1730 Content-Disposition Header Field
1731
1732 @item RFC2646
1733 Documentation of the text/plain format parameter for flowed text.
1734
1735 @end table
1736
1737
1738 @node Index
1739 @chapter Index
1740 @printindex cp
1741
1742 @summarycontents
1743 @contents
1744 @bye
1745
1746 \f
1747 @c Local Variables:
1748 @c mode: texinfo
1749 @c coding: iso-8859-1
1750 @c End: