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