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