[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to emacs-mime.texi
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] Changes to emacs-mime.texi |
|
Date: |
Thu, 06 Sep 2007 04:35:33 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Changes by: Glenn Morris <gm> 07/09/06 04:35:33
Index: emacs-mime.texi
===================================================================
RCS file: emacs-mime.texi
diff -N emacs-mime.texi
--- emacs-mime.texi 13 Jul 2007 19:44:45 -0000 1.39
+++ /dev/null 1 Jan 1970 00:00:00 -0000
@@ -1,1832 +0,0 @@
-\input texinfo
-
address@hidden ../info/emacs-mime
address@hidden Emacs MIME Manual
address@hidden fn cp
address@hidden vr cp
address@hidden pg cp
-
address@hidden
-This file documents the Emacs MIME interface functionality.
-
-Copyright @copyright{} 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-2006, 2007 Free Software Foundation, Inc.
-
address@hidden
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.2 or
-any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU
-Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
-license is included in the section entitled ``GNU Free Documentation
-License'' in the Emacs manual.
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
-this GNU Manual, like GNU software. Copies published by the Free
-Software Foundation raise funds for GNU development.''
-
-This document is part of a collection distributed under the GNU Free
-Documentation License. If you want to distribute this document
-separately from the collection, you can do so by adding a copy of the
-license to the document, as described in section 6 of the license.
address@hidden quotation
address@hidden copying
-
address@hidden Node ``Interface Functions'' uses Latin-1 characters
address@hidden ISO-8859-1
-
address@hidden Emacs
address@hidden
-* Emacs MIME: (emacs-mime). Emacs MIME de/composition library.
address@hidden direntry
address@hidden
address@hidden
address@hidden iftex
address@hidden odd
-
address@hidden
address@hidden Emacs MIME Manual
-
address@hidden by Lars Magne Ingebrigtsen
address@hidden
address@hidden 0pt plus 1filll
address@hidden
address@hidden titlepage
-
address@hidden Top
address@hidden Emacs MIME
-
-This manual documents the libraries used to compose and display
address@hidden messages.
-
-This manual is directed at users who want to modify the behavior of
-the @acronym{MIME} encoding/decoding process or want a more detailed
-picture of how the Emacs @acronym{MIME} library works, and people who want
-to write functions and commands that manipulate @acronym{MIME} elements.
-
address@hidden is short for @dfn{Multipurpose Internet Mail Extensions}.
-This standard is documented in a number of RFCs; mainly RFC2045 (Format
-of Internet Message Bodies), RFC2046 (Media Types), RFC2047 (Message
-Header Extensions for address@hidden Text), RFC2048 (Registration
-Procedures), RFC2049 (Conformance Criteria and Examples). It is highly
-recommended that anyone who intends writing @acronym{MIME}-compliant software
-read at least RFC2045 and RFC2047.
-
address@hidden
-* Decoding and Viewing:: A framework for decoding and viewing.
-* Composing:: @acronym{MML}; a language for describing
@acronym{MIME} parts.
-* Interface Functions:: An abstraction over the basic functions.
-* Basic Functions:: Utility and basic parsing functions.
-* Standards:: A summary of RFCs and working documents used.
-* GNU Free Documentation License:: The license for this documentation.
-* Index:: Function and variable index.
address@hidden menu
-
-
address@hidden Decoding and Viewing
address@hidden Decoding and Viewing
-
-This chapter deals with decoding and viewing @acronym{MIME} messages on a
-higher level.
-
-The main idea is to first analyze a @acronym{MIME} article, and then allow
-other programs to do things based on the list of @dfn{handles} that are
-returned as a result of this analysis.
-
address@hidden
-* Dissection:: Analyzing a @acronym{MIME} message.
-* Non-MIME:: Analyzing a address@hidden message.
-* Handles:: Handle manipulations.
-* Display:: Displaying handles.
-* Display Customization:: Variables that affect display.
-* Files and Directories:: Saving and naming attachments.
-* New Viewers:: How to write your own viewers.
address@hidden menu
-
-
address@hidden Dissection
address@hidden Dissection
-
-The @code{mm-dissect-buffer} is the function responsible for dissecting
-a @acronym{MIME} article. If given a multipart message, it will recursively
-descend the message, following the structure, and return a tree of
address@hidden handles that describes the structure of the message.
-
address@hidden Non-MIME
address@hidden Non-MIME
address@hidden mm-uu-configure-list
-
-Gnus also understands some address@hidden attachments, such as
-postscript, uuencode, binhex, yenc, shar, forward, gnatsweb, pgp,
-diff. Each of these features can be disabled by add an item into
address@hidden For example,
-
address@hidden
-(require 'mm-uu)
-(add-to-list 'mm-uu-configure-list '(pgp-signed . disabled))
address@hidden lisp
-
address@hidden @code
address@hidden postscript
address@hidden postscript
-PostScript file.
-
address@hidden uu
address@hidden uu
-Uuencoded file.
-
address@hidden binhex
address@hidden binhex
-Binhex encoded file.
-
address@hidden yenc
address@hidden yenc
-Yenc encoded file.
-
address@hidden shar
address@hidden shar
-Shar archive file.
-
address@hidden forward
address@hidden forward
address@hidden forwarded message.
-
address@hidden gnatsweb
address@hidden gnatsweb
-Gnatsweb attachment.
-
address@hidden pgp-signed
address@hidden pgp-signed
address@hidden signed clear text.
-
address@hidden pgp-encrypted
address@hidden pgp-encrypted
address@hidden encrypted clear text.
-
address@hidden pgp-key
address@hidden pgp-key
address@hidden public keys.
-
address@hidden emacs-sources
address@hidden emacs-sources
address@hidden mm-uu-emacs-sources-regexp
-Emacs source code. This item works only in the groups matching
address@hidden
-
address@hidden diff
address@hidden diff
address@hidden mm-uu-diff-groups-regexp
-Patches. This is intended for groups where diffs of committed files
-are automatically sent to. It only works in groups matching
address@hidden
-
address@hidden table
-
address@hidden Handles
address@hidden Handles
-
-A @acronym{MIME} handle is a list that fully describes a @acronym{MIME}
-component.
-
-The following macros can be used to access elements in a handle:
-
address@hidden @code
address@hidden mm-handle-buffer
address@hidden mm-handle-buffer
-Return the buffer that holds the contents of the undecoded @acronym{MIME}
-part.
-
address@hidden mm-handle-type
address@hidden mm-handle-type
-Return the parsed @code{Content-Type} of the part.
-
address@hidden mm-handle-encoding
address@hidden mm-handle-encoding
-Return the @code{Content-Transfer-Encoding} of the part.
-
address@hidden mm-handle-undisplayer
address@hidden mm-handle-undisplayer
-Return the object that can be used to remove the displayed part (if it
-has been displayed).
-
address@hidden mm-handle-set-undisplayer
address@hidden mm-handle-set-undisplayer
-Set the undisplayer object.
-
address@hidden mm-handle-disposition
address@hidden mm-handle-disposition
-Return the parsed @code{Content-Disposition} of the part.
-
address@hidden mm-get-content-id
-Returns the handle(s) referred to by @code{Content-ID}.
-
address@hidden table
-
-
address@hidden Display
address@hidden Display
-
-Functions for displaying, removing and saving.
-
address@hidden @code
address@hidden mm-display-part
address@hidden mm-display-part
-Display the part.
-
address@hidden mm-remove-part
address@hidden mm-remove-part
-Remove the part (if it has been displayed).
-
address@hidden mm-inlinable-p
address@hidden mm-inlinable-p
-Say whether a @acronym{MIME} type can be displayed inline.
-
address@hidden mm-automatic-display-p
address@hidden mm-automatic-display-p
-Say whether a @acronym{MIME} type should be displayed automatically.
-
address@hidden mm-destroy-part
address@hidden mm-destroy-part
-Free all resources occupied by a part.
-
address@hidden mm-save-part
address@hidden mm-save-part
-Offer to save the part in a file.
-
address@hidden mm-pipe-part
address@hidden mm-pipe-part
-Offer to pipe the part to some process.
-
address@hidden mm-interactively-view-part
address@hidden mm-interactively-view-part
-Prompt for a mailcap method to use to view the part.
-
address@hidden table
-
-
address@hidden Display Customization
address@hidden Display Customization
-
address@hidden @code
-
address@hidden mm-inline-media-tests
address@hidden mm-inline-media-tests
-This is an alist where the key is a @acronym{MIME} type, the second element
-is a function to display the part @dfn{inline} (i.e., inside Emacs), and
-the third element is a form to be @code{eval}ed to say whether the part
-can be displayed inline.
-
-This variable specifies whether a part @emph{can} be displayed inline,
-and, if so, how to do it. It does not say whether parts are
address@hidden displayed inline.
-
address@hidden mm-inlined-types
address@hidden mm-inlined-types
-This, on the other hand, says what types are to be displayed inline, if
-they satisfy the conditions set by the variable above. It's a list of
address@hidden media types.
-
address@hidden mm-automatic-display
address@hidden mm-automatic-display
-This is a list of types that are to be displayed ``automatically'', but
-only if the above variable allows it. That is, only inlinable parts can
-be displayed automatically.
-
address@hidden mm-automatic-external-display
address@hidden mm-automatic-external-display
-This is a list of types that will be displayed automatically in an
-external viewer.
-
address@hidden mm-keep-viewer-alive-types
address@hidden mm-keep-viewer-alive-types
-This is a list of media types for which the external viewer will not
-be killed when selecting a different article.
-
address@hidden mm-attachment-override-types
address@hidden mm-attachment-override-types
-Some @acronym{MIME} agents create parts that have a content-disposition of
address@hidden This variable allows overriding that disposition and
-displaying the part inline. (Note that the disposition is only
-overridden if we are able to, and want to, display the part inline.)
-
address@hidden mm-discouraged-alternatives
address@hidden mm-discouraged-alternatives
-List of @acronym{MIME} types that are discouraged when viewing
address@hidden/alternative}. Viewing agents are supposed to view the
-last possible part of a message, as that is supposed to be the richest.
-However, users may prefer other types instead, and this list says what
-types are most unwanted. If, for instance, @samp{text/html} parts are
-very unwanted, and @samp{text/richtext} parts are somewhat unwanted,
-you could say something like:
-
address@hidden
-(setq mm-discouraged-alternatives
- '("text/html" "text/richtext")
- mm-automatic-display
- (remove "text/html" mm-automatic-display))
address@hidden lisp
-
-Adding @code{"image/.*"} might also be useful. Spammers use images as
-the preferred part of @samp{multipart/alternative} messages, so you might
-not notice there are other parts. See also
address@hidden, @ref{MIME Commands, ,MIME Commands,
-gnus, Gnus Manual}. After adding @code{"multipart/alternative"} to
address@hidden you can choose manually which
-alternative you'd like to view. For example, you can set those
-variables like:
-
address@hidden
-(setq gnus-buttonized-mime-types
- '("multipart/alternative" "multipart/signed")
- mm-discouraged-alternatives
- '("text/html" "image/.*"))
address@hidden lisp
-
-In this case, Gnus will display radio buttons for such a kind of spam
-message as follows:
-
address@hidden
-1. (*) multipart/alternative ( ) image/gif
-
-2. (*) text/plain ( ) text/html
address@hidden example
-
address@hidden mm-inline-large-images
address@hidden mm-inline-large-images
-When displaying inline images that are larger than the window, Emacs
-does not enable scrolling, which means that you cannot see the whole
-image. To prevent this, the library tries to determine the image size
-before displaying it inline, and if it doesn't fit the window, the
-library will display it externally (e.g. with @samp{ImageMagick} or
address@hidden). Setting this variable to @code{t} disables this check and
-makes the library display all inline images as inline, regardless of
-their size.
-
address@hidden mm-inline-override-types
address@hidden mm-inline-override-types
address@hidden may include regular expressions, for example to
-specify that all @samp{text/.*} parts be displayed inline. If a user
-prefers to have a type that matches such a regular expression be treated
-as an attachment, that can be accomplished by setting this variable to a
-list containing that type. For example assuming @code{mm-inlined-types}
-includes @samp{text/.*}, then including @samp{text/html} in this
-variable will cause @samp{text/html} parts to be treated as attachments.
-
address@hidden mm-text-html-renderer
address@hidden mm-text-html-renderer
-This selects the function used to render @acronym{HTML}. The predefined
-renderers are selected by the symbols @code{w3},
address@hidden@footnote{See @uref{http://emacs-w3m.namazu.org/} for more
-information about emacs-w3m}, @code{links}, @code{lynx},
address@hidden or @code{html2text}. If @code{nil} use an
-external viewer. You can also specify a function, which will be
-called with a @acronym{MIME} handle as the argument.
-
address@hidden mm-inline-text-html-with-images
address@hidden mm-inline-text-html-with-images
-Some @acronym{HTML} mails might have the trick of spammers using
address@hidden<img>} tags. It is likely to be intended to verify whether you
-have read the mail. You can prevent your personal informations from
-leaking by setting this option to @code{nil} (which is the default).
-It is currently ignored by Emacs/w3. For emacs-w3m, you may use the
-command @kbd{t} on the image anchor to show an image even if it is
address@hidden@footnote{The command @kbd{T} will load all images. If you
-have set the option @code{w3m-key-binding} to @code{info}, use @kbd{i}
-or @kbd{I} instead.}
-
address@hidden mm-w3m-safe-url-regexp
address@hidden mm-w3m-safe-url-regexp
-A regular expression that matches safe URL names, i.e. URLs that are
-unlikely to leak personal information when rendering @acronym{HTML}
-email (the default value is @samp{\\`cid:}). If @code{nil} consider
-all URLs safe.
-
address@hidden mm-inline-text-html-with-w3m-keymap
address@hidden mm-inline-text-html-with-w3m-keymap
-You can use emacs-w3m command keys in the inlined text/html part by
-setting this option to address@hidden The default value is @code{t}.
-
address@hidden mm-external-terminal-program
address@hidden mm-external-terminal-program
-The program used to start an external terminal.
-
address@hidden mm-enable-external
address@hidden mm-enable-external
-Indicate whether external @acronym{MIME} handlers should be used.
-
-If @code{t}, all defined external @acronym{MIME} handlers are used. If
address@hidden, files are saved to disk (@code{mailcap-save-binary-file}).
-If it is the symbol @code{ask}, you are prompted before the external
address@hidden handler is invoked.
-
-When you launch an attachment through mailcap (@pxref{mailcap}) an
-attempt is made to use a safe viewer with the safest options---this isn't
-the case if you save it to disk and launch it in a different way
-(command line or double-clicking). Anyhow, if you want to be sure not
-to launch any external programs, set this variable to @code{nil} or
address@hidden
-
address@hidden table
-
address@hidden Files and Directories
address@hidden Files and Directories
-
address@hidden @code
-
address@hidden mm-default-directory
address@hidden mm-default-directory
-The default directory for saving attachments. If @code{nil} use
address@hidden
-
address@hidden mm-tmp-directory
address@hidden mm-tmp-directory
-Directory for storing temporary files.
-
address@hidden mm-file-name-rewrite-functions
address@hidden mm-file-name-rewrite-functions
-A list of functions used for rewriting file names of @acronym{MIME}
-parts. Each function is applied successively to the file name.
-Ready-made functions include
-
address@hidden @code
address@hidden mm-file-name-delete-control
address@hidden mm-file-name-delete-control
-Delete all control characters.
-
address@hidden mm-file-name-delete-gotchas
address@hidden mm-file-name-delete-gotchas
-Delete characters that could have unintended consequences when used
-with flawed shell scripts, i.e. @samp{|}, @samp{>} and @samp{<}; and
address@hidden, @samp{.} as the first character.
-
address@hidden mm-file-name-delete-whitespace
address@hidden mm-file-name-delete-whitespace
-Remove all whitespace.
-
address@hidden mm-file-name-trim-whitespace
address@hidden mm-file-name-trim-whitespace
-Remove leading and trailing whitespace.
-
address@hidden mm-file-name-collapse-whitespace
address@hidden mm-file-name-collapse-whitespace
-Collapse multiple whitespace characters.
-
address@hidden mm-file-name-replace-whitespace
address@hidden mm-file-name-replace-whitespace
address@hidden mm-file-name-replace-whitespace
-Replace whitespace with underscores. Set the variable
address@hidden to any other string if you do
-not like underscores.
address@hidden table
-
-The standard Emacs functions @code{capitalize}, @code{downcase},
address@hidden and @code{upcase-initials} might also prove useful.
-
address@hidden mm-path-name-rewrite-functions
address@hidden mm-path-name-rewrite-functions
-List of functions used for rewriting the full file names of @acronym{MIME}
-parts. This is used when viewing parts externally, and is meant for
-transforming the absolute name so that non-compliant programs can find
-the file where it's saved.
-
address@hidden table
-
address@hidden New Viewers
address@hidden New Viewers
-
-Here's an example viewer for displaying @code{text/enriched} inline:
-
address@hidden
-(defun mm-display-enriched-inline (handle)
- (let (text)
- (with-temp-buffer
- (mm-insert-part handle)
- (save-window-excursion
- (enriched-decode (point-min) (point-max))
- (setq text (buffer-string))))
- (mm-insert-inline handle text)))
address@hidden lisp
-
-We see that the function takes a @acronym{MIME} handle as its parameter. It
-then goes to a temporary buffer, inserts the text of the part, does some
-work on the text, stores the result, goes back to the buffer it was
-called from and inserts the result.
-
-The two important helper functions here are @code{mm-insert-part} and
address@hidden The first function inserts the text of the
-handle in the current buffer. It handles charset and/or content
-transfer decoding. The second function just inserts whatever text you
-tell it to insert, but it also sets things up so that the text can be
-``undisplayed'' in a convenient manner.
-
-
address@hidden Composing
address@hidden Composing
address@hidden Composing
address@hidden MIME Composing
address@hidden MML
address@hidden MIME Meta Language
-
-Creating a @acronym{MIME} message is boring and non-trivial. Therefore,
-a library called @code{mml} has been defined that parses a language
-called @acronym{MML} (@acronym{MIME} Meta Language) and generates
address@hidden messages.
-
address@hidden mml-generate-mime
-The main interface function is @code{mml-generate-mime}. It will
-examine the contents of the current (narrowed-to) buffer and return a
-string containing the @acronym{MIME} message.
-
address@hidden
-* Simple MML Example:: An example @acronym{MML} document.
-* MML Definition:: All valid @acronym{MML} elements.
-* Advanced MML Example:: Another example @acronym{MML} document.
-* Encoding Customization:: Variables that affect encoding.
-* Charset Translation:: How charsets are mapped from @sc{mule} to
@acronym{MIME}.
-* Conversion:: Going from @acronym{MIME} to @acronym{MML}
and vice versa.
-* Flowed text:: Soft and hard newlines.
address@hidden menu
-
-
address@hidden Simple MML Example
address@hidden Simple MML Example
-
-Here's a simple @samp{multipart/alternative}:
-
address@hidden
-<#multipart type=alternative>
-This is a plain text part.
-<#part type=text/enriched>
-<center>This is a centered enriched part</center>
-<#/multipart>
address@hidden example
-
-After running this through @code{mml-generate-mime}, we get this:
-
address@hidden
-Content-Type: multipart/alternative; boundary="=-=-="
-
-
---=-=-=
-
-
-This is a plain text part.
-
---=-=-=
-Content-Type: text/enriched
-
-
-<center>This is a centered enriched part</center>
-
---=-=-=--
address@hidden example
-
-
address@hidden MML Definition
address@hidden MML Definition
-
-The @acronym{MML} language is very simple. It looks a bit like an SGML
-application, but it's not.
-
-The main concept of @acronym{MML} is the @dfn{part}. Each part can be of a
-different type or use a different charset. The way to delineate a part
-is with a @samp{<#part ...>} tag. Multipart parts can be introduced
-with the @samp{<#multipart ...>} tag. Parts are ended by the
address@hidden<#/part>} or @samp{<#/multipart>} tags. Parts started with the
address@hidden<#part ...>} tags are also closed by the next open tag.
-
-There's also the @samp{<#external ...>} tag. These introduce
address@hidden/message-body} parts.
-
-Each tag can contain zero or more parameters on the form
address@hidden The values may be enclosed in quotation marks,
-but that's not necessary unless the value contains white space. So
address@hidden/home/user/#hello$^yes} is perfectly valid.
-
-The following parameters have meaning in @acronym{MML}; parameters that have no
-meaning are ignored. The @acronym{MML} parameter names are the same as the
address@hidden parameter names; the things in the parentheses say which
-header it will be used in.
-
address@hidden @samp
address@hidden type
-The @acronym{MIME} type of the part (@code{Content-Type}).
-
address@hidden filename
-Use the contents of the file in the body of the part
-(@code{Content-Disposition}).
-
address@hidden charset
-The contents of the body of the part are to be encoded in the character
-set specified (@code{Content-Type}). @xref{Charset Translation}.
-
address@hidden name
-Might be used to suggest a file name if the part is to be saved
-to a file (@code{Content-Type}).
-
address@hidden disposition
-Valid values are @samp{inline} and @samp{attachment}
-(@code{Content-Disposition}).
-
address@hidden encoding
-Valid values are @samp{7bit}, @samp{8bit}, @samp{quoted-printable} and
address@hidden (@code{Content-Transfer-Encoding}). @xref{Charset
-Translation}.
-
address@hidden description
-A description of the part (@code{Content-Description}).
-
address@hidden creation-date
-RFC822 date when the part was created (@code{Content-Disposition}).
-
address@hidden modification-date
-RFC822 date when the part was modified (@code{Content-Disposition}).
-
address@hidden read-date
-RFC822 date when the part was read (@code{Content-Disposition}).
-
address@hidden recipients
-Who to encrypt/sign the part to. This field is used to override any
-auto-detection based on the To/CC headers.
-
address@hidden sender
-Identity used to sign the part. This field is used to override the
-default key used.
-
address@hidden size
-The size (in octets) of the part (@code{Content-Disposition}).
-
address@hidden sign
-What technology to sign this @acronym{MML} part with (@code{smime}, @code{pgp}
-or @code{pgpmime})
-
address@hidden encrypt
-What technology to encrypt this @acronym{MML} part with (@code{smime},
address@hidden or @code{pgpmime})
-
address@hidden table
-
-Parameters for @samp{text/plain}:
-
address@hidden @samp
address@hidden format
-Formatting parameter for the text, valid values include @samp{fixed}
-(the default) and @samp{flowed}. Normally you do not specify this
-manually, since it requires the textual body to be formatted in a
-special way described in RFC 2646. @xref{Flowed text}.
address@hidden table
-
-Parameters for @samp{application/octet-stream}:
-
address@hidden @samp
address@hidden type
-Type of the part; informal---meant for human readers
-(@code{Content-Type}).
address@hidden table
-
-Parameters for @samp{message/external-body}:
-
address@hidden @samp
address@hidden access-type
-A word indicating the supported access mechanism by which the file may
-be obtained. Values include @samp{ftp}, @samp{anon-ftp}, @samp{tftp},
address@hidden, and @samp{mailserver}. (@code{Content-Type}.)
-
address@hidden expiration
-The RFC822 date after which the file may no longer be fetched.
-(@code{Content-Type}.)
-
address@hidden size
-The size (in octets) of the file. (@code{Content-Type}.)
-
address@hidden permission
-Valid values are @samp{read} and @samp{read-write}
-(@code{Content-Type}).
-
address@hidden table
-
-Parameters for @samp{sign=smime}:
-
address@hidden @samp
-
address@hidden keyfile
-File containing key and certificate for signer.
-
address@hidden table
-
-Parameters for @samp{encrypt=smime}:
-
address@hidden @samp
-
address@hidden certfile
-File containing certificate for recipient.
-
address@hidden table
-
-
address@hidden Advanced MML Example
address@hidden Advanced MML Example
-
-Here's a complex multipart message. It's a @samp{multipart/mixed} that
-contains many parts, one of which is a @samp{multipart/alternative}.
-
address@hidden
-<#multipart type=mixed>
-<#part type=image/jpeg filename=~/rms.jpg disposition=inline>
-<#multipart type=alternative>
-This is a plain text part.
-<#part type=text/enriched name=enriched.txt>
-<center>This is a centered enriched part</center>
-<#/multipart>
-This is a new plain text part.
-<#part disposition=attachment>
-This plain text part is an attachment.
-<#/multipart>
address@hidden example
-
-And this is the resulting @acronym{MIME} message:
-
address@hidden
-Content-Type: multipart/mixed; boundary="=-=-="
-
-
---=-=-=
-
-
-
---=-=-=
-Content-Type: image/jpeg;
- filename="~/rms.jpg"
-Content-Disposition: inline;
- filename="~/rms.jpg"
-Content-Transfer-Encoding: base64
-
-/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRof
-Hh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCAAwADABAREA/8QAHwAA
-AQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQR
-BRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RF
-RkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ip
-qrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEB
-AAA/AO/rifFHjldNuGsrDa0qcSSHkA+gHrXKw+LtWLrMb+RgTyhbr+HSug07xNqV9fQtZrNI
-AyiaE/NuBPOOOP0rvRNE880KOC8TbXXGCv1FPqjrF4LDR7u5L7SkTFT/ALWOP1xXgTuXfc7E
-sx6nua6rwp4IvvEM8chCxWxOdzn7wz6V9AaB4S07w9p5itow0rDLSY5Pt9K43xO66P4xs71m
-2QXiGCbA4yOVJ9+1aYORkdK434lyNH4ahCnG66VT9Nj15JFbPdX0MS43M4VQf5/yr2vSpLnw
-5ZW8dlCZ8KFXjOPX0/mK6rSPEGt3Angu44fNEReHYNvIH3TzXDeKNO8RX+kSX2ouZkicTIOc
-L+g7E810ulFjpVtv3bwgB3HJyK5L4quY/C9sVxk3ij/xx6850u7t1mtp/wDlpEw3An3Jr3Dw
-34gsbWza4nBlhC5LDsaW6+IFgupQyCF3iHH7gA7c9R9ay7zx6t7aX9jHC4smhfBkGCvHGfrm
-tLQ7hbnRrV1GPkAP1x1/Hr+Ncr8Vzjwrbf8AX6v/AKA9eQRyYlQk8Yx9K6XTNbkgia2ciSIn
-7p5Ga9Atte0LTLKO6it4i7dVRFJDcZ4PvXN+JvEMF9bILVGXJLSZ4zkjivRPDaeX4b08HOTC
-pOffmua+KkbS+GLVUGT9tT/0B68eeIpIFYjB70+OOVXyoOM9+M1eaWeCLzHPyHGO/NVWvJJm
-jQ8KGH1NfQWhXSXmh2c8eArRLwO3HSv/2Q==
-
---=-=-=
-Content-Type: multipart/alternative; boundary="==-=-="
-
-
---==-=-=
-
-
-This is a plain text part.
-
---==-=-=
-Content-Type: text/enriched;
- name="enriched.txt"
-
-
-<center>This is a centered enriched part</center>
-
---==-=-=--
-
---=-=-=
-
-This is a new plain text part.
-
---=-=-=
-Content-Disposition: attachment
-
-
-This plain text part is an attachment.
-
---=-=-=--
address@hidden example
-
address@hidden Encoding Customization
address@hidden Encoding Customization
-
address@hidden @code
-
address@hidden mm-body-charset-encoding-alist
address@hidden mm-body-charset-encoding-alist
-Mapping from @acronym{MIME} charset to encoding to use. This variable is
-usually used except, e.g., when other requirements force a specific
-encoding (digitally signed messages require 7bit encodings). The
-default is
-
address@hidden
-((iso-2022-jp . 7bit)
- (iso-2022-jp-2 . 7bit)
- (utf-16 . base64)
- (utf-16be . base64)
- (utf-16le . base64))
address@hidden lisp
-
-As an example, if you do not want to have ISO-8859-1 characters
-quoted-printable encoded, you may add @code{(iso-8859-1 . 8bit)} to
-this variable. You can override this setting on a per-message basis
-by using the @code{encoding} @acronym{MML} tag (@pxref{MML Definition}).
-
address@hidden mm-coding-system-priorities
address@hidden mm-coding-system-priorities
-Prioritize coding systems to use for outgoing messages. The default
-is @code{nil}, which means to use the defaults in Emacs, but is
address@hidden(iso-8859-1 iso-2022-jp iso-2022-jp-2 shift_jis utf-8)} when
-running Emacs in the Japanese language environment. It is a list of
-coding system symbols (aliases of coding systems are also allowed, use
address@hidden describe-coding-system} to make sure you are specifying correct
-coding system names). For example, if you have configured Emacs
-to prefer UTF-8, but wish that outgoing messages should be sent in
-ISO-8859-1 if possible, you can set this variable to
address@hidden(iso-8859-1)}. You can override this setting on a per-message
-basis by using the @code{charset} @acronym{MML} tag (@pxref{MML Definition}).
-
address@hidden mm-content-transfer-encoding-defaults
address@hidden mm-content-transfer-encoding-defaults
-Mapping from @acronym{MIME} types to encoding to use. This variable is usually
-used except, e.g., when other requirements force a safer encoding
-(digitally signed messages require 7bit encoding). Besides the normal
address@hidden encodings, @code{qp-or-base64} may be used to indicate that for
-each case the most efficient of quoted-printable and base64 should be
-used.
-
address@hidden has another effect. It will fold long lines so that
-MIME parts may not be broken by MTA. So do @code{quoted-printable} and
address@hidden
-
-Note that it affects body encoding only when a part is a raw forwarded
-message (which will be made by @code{gnus-summary-mail-forward} with the
-arg 2 for example) or is neither the @samp{text/*} type nor the
address@hidden/*} type. Even though in those cases, you can override
-this setting on a per-message basis by using the @code{encoding}
address@hidden tag (@pxref{MML Definition}).
-
address@hidden mm-use-ultra-safe-encoding
address@hidden mm-use-ultra-safe-encoding
-When this is address@hidden, it means that textual parts are encoded as
-quoted-printable if they contain lines longer than 76 characters or
-starting with "From " in the body. Non-7bit encodings (8bit, binary)
-are generally disallowed. This reduce the probability that a non-8bit
-clean MTA or MDA changes the message. This should never be set
-directly, but bound by other functions when necessary (e.g., when
-encoding messages that are to be digitally signed).
-
address@hidden table
-
address@hidden Charset Translation
address@hidden Charset Translation
address@hidden charsets
-
-During translation from @acronym{MML} to @acronym{MIME}, for each
address@hidden part which has been composed inside Emacs, an appropriate
-charset has to be chosen.
-
address@hidden mail-parse-charset
-If you are running a address@hidden Emacs, this process is simple: If the
-part contains any address@hidden (8-bit) characters, the @acronym{MIME} charset
-given by @code{mail-parse-charset} (a symbol) is used. (Never set this
-variable directly, though. If you want to change the default charset,
-please consult the documentation of the package which you use to process
address@hidden messages.
address@hidden Message Variables, , Various Message Variables, message,
- Message Manual}, for example.)
-If there are only @acronym{ASCII} characters, the @acronym{MIME} charset
US-ASCII is
-used, of course.
-
address@hidden MULE
address@hidden UTF-8
address@hidden Unicode
address@hidden mm-mime-mule-charset-alist
-Things are slightly more complicated when running Emacs with @sc{mule}
-support. In this case, a list of the @sc{mule} charsets used in the
-part is obtained, and the @sc{mule} charsets are translated to
address@hidden charsets by consulting the table provided by Emacs itself
-or the variable @code{mm-mime-mule-charset-alist} for XEmacs.
-If this results in a single @acronym{MIME} charset, this is used to encode
-the part. But if the resulting list of @acronym{MIME} charsets contains more
-than one element, two things can happen: If it is possible to encode the
-part via UTF-8, this charset is used. (For this, Emacs must support
-the @code{utf-8} coding system, and the part must consist entirely of
-characters which have Unicode counterparts.) If UTF-8 is not available
-for some reason, the part is split into several ones, so that each one
-can be encoded with a single @acronym{MIME} charset. The part can only be
-split at line boundaries, though---if more than one @acronym{MIME} charset is
-required to encode a single line, it is not possible to encode the part.
-
-When running Emacs with @sc{mule} support, the preferences for which
-coding system to use is inherited from Emacs itself. This means that
-if Emacs is set up to prefer UTF-8, it will be used when encoding
-messages. You can modify this by altering the
address@hidden variable though (@pxref{Encoding
-Customization}).
-
-The charset to be used can be overridden by setting the @code{charset}
address@hidden tag (@pxref{MML Definition}) when composing the message.
-
-The encoding of characters (quoted-printable, 8bit etc) is orthogonal
-to the discussion here, and is controlled by the variables
address@hidden and
address@hidden (@pxref{Encoding
-Customization}).
-
address@hidden Conversion
address@hidden Conversion
-
address@hidden mime-to-mml
-A (multipart) @acronym{MIME} message can be converted to @acronym{MML}
-with the @code{mime-to-mml} function. It works on the message in the
-current buffer, and substitutes @acronym{MML} markup for @acronym{MIME}
-boundaries. Non-textual parts do not have their contents in the buffer,
-but instead have the contents in separate buffers that are referred to
-from the @acronym{MML} tags.
-
address@hidden mml-to-mime
-An @acronym{MML} message can be converted back to @acronym{MIME} by the
address@hidden function.
-
-These functions are in certain senses ``lossy''---you will not get back
-an identical message if you run @code{mime-to-mml} and then
address@hidden Not only will trivial things like the order of the
-headers differ, but the contents of the headers may also be different.
-For instance, the original message may use base64 encoding on text,
-while @code{mml-to-mime} may decide to use quoted-printable encoding, and
-so on.
-
-In essence, however, these two functions should be the inverse of each
-other. The resulting contents of the message should remain equivalent,
-if not identical.
-
-
address@hidden Flowed text
address@hidden Flowed text
address@hidden format=flowed
-
-The Emacs @acronym{MIME} library will respect the @code{use-hard-newlines}
-variable (@pxref{Hard and Soft Newlines, ,Hard and Soft Newlines,
-emacs, Emacs Manual}) when encoding a message, and the
-``format=flowed'' Content-Type parameter when decoding a message.
-
-On encoding text, regardless of @code{use-hard-newlines}, lines
-terminated by soft newline characters are filled together and wrapped
-after the column decided by @code{fill-flowed-encode-column}.
-Quotation marks (matching @samp{^>* ?}) are respected. The variable
-controls how the text will look in a client that does not support
-flowed text, the default is to wrap after 66 characters. If hard
-newline characters are not present in the buffer, no flow encoding
-occurs.
-
-On decoding flowed text, lines with soft newline characters are filled
-together and wrapped after the column decided by
address@hidden The default is to wrap after
address@hidden
-
address@hidden @code
address@hidden mm-fill-flowed
address@hidden mm-fill-flowed
-If address@hidden a format=flowed article will be displayed flowed.
address@hidden table
-
-
address@hidden Interface Functions
address@hidden Interface Functions
address@hidden interface functions
address@hidden mail-parse
-
-The @code{mail-parse} library is an abstraction over the actual
-low-level libraries that are described in the next chapter.
-
-Standards change, and so programs have to change to fit in the new
-mold. For instance, RFC2045 describes a syntax for the
address@hidden header that only allows @acronym{ASCII} characters in the
-parameter list. RFC2231 expands on RFC2045 syntax to provide a scheme
-for continuation headers and address@hidden characters.
-
-The traditional way to deal with this is just to update the library
-functions to parse the new syntax. However, this is sometimes the wrong
-thing to do. In some instances it may be vital to be able to understand
-both the old syntax as well as the new syntax, and if there is only one
-library, one must choose between the old version of the library and the
-new version of the library.
-
-The Emacs @acronym{MIME} library takes a different tack. It defines a
-series of low-level libraries (@file{rfc2047.el}, @file{rfc2231.el}
-and so on) that parses strictly according to the corresponding
-standard. However, normal programs would not use the functions
-provided by these libraries directly, but instead use the functions
-provided by the @code{mail-parse} library. The functions in this
-library are just aliases to the corresponding functions in the latest
-low-level libraries. Using this scheme, programs get a consistent
-interface they can use, and library developers are free to create
-write code that handles new standards.
-
-The following functions are defined by this library:
-
address@hidden @code
address@hidden mail-header-parse-content-type
address@hidden mail-header-parse-content-type
-Parse a @code{Content-Type} header and return a list on the following
-format:
-
address@hidden
-("type/subtype"
- (attribute1 . value1)
- (attribute2 . value2)
- ...)
address@hidden lisp
-
-Here's an example:
-
address@hidden
-(mail-header-parse-content-type
- "image/gif; name=\"b980912.gif\"")
address@hidden ("image/gif" (name . "b980912.gif"))
address@hidden example
-
address@hidden mail-header-parse-content-disposition
address@hidden mail-header-parse-content-disposition
-Parse a @code{Content-Disposition} header and return a list on the same
-format as the function above.
-
address@hidden mail-content-type-get
address@hidden mail-content-type-get
-Takes two parameters---a list on the format above, and an attribute.
-Returns the value of the attribute.
-
address@hidden
-(mail-content-type-get
- '("image/gif" (name . "b980912.gif")) 'name)
address@hidden "b980912.gif"
address@hidden example
-
address@hidden mail-header-encode-parameter
address@hidden mail-header-encode-parameter
-Takes a parameter string and returns an encoded version of the string.
-This is used for parameters in headers like @code{Content-Type} and
address@hidden
-
address@hidden mail-header-remove-comments
address@hidden mail-header-remove-comments
-Return a comment-free version of a header.
-
address@hidden
-(mail-header-remove-comments
- "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)")
address@hidden "Gnus/5.070027 "
address@hidden example
-
address@hidden mail-header-remove-whitespace
address@hidden mail-header-remove-whitespace
-Remove linear white space from a header. Space inside quoted strings
-and comments is preserved.
-
address@hidden
-(mail-header-remove-whitespace
- "image/gif; name=\"Name with spaces\"")
address@hidden "image/gif;name=\"Name with spaces\""
address@hidden example
-
address@hidden mail-header-get-comment
address@hidden mail-header-get-comment
-Return the last comment in a header.
-
address@hidden
-(mail-header-get-comment
- "Gnus/5.070027 (Pterodactyl Gnus v0.27) (Finnish Landrace)")
address@hidden "Finnish Landrace"
address@hidden example
-
address@hidden mail-header-parse-address
address@hidden mail-header-parse-address
-Parse an address and return a list containing the mailbox and the
-plaintext name.
-
address@hidden
-(mail-header-parse-address
- "Hrvoje Niksic <hniksic@@srce.hr>")
address@hidden ("hniksic@@srce.hr" . "Hrvoje Niksic")
address@hidden example
-
address@hidden mail-header-parse-addresses
address@hidden mail-header-parse-addresses
-Parse a string with list of addresses and return a list of elements like
-the one described above.
-
address@hidden
-(mail-header-parse-addresses
- "Hrvoje Niksic <hniksic@@srce.hr>, Steinar Bang <sb@@metis.no>")
address@hidden (("hniksic@@srce.hr" . "Hrvoje Niksic")
- ("sb@@metis.no" . "Steinar Bang"))
address@hidden example
-
address@hidden mail-header-parse-date
address@hidden mail-header-parse-date
-Parse a date string and return an Emacs time structure.
-
address@hidden mail-narrow-to-head
address@hidden mail-narrow-to-head
-Narrow the buffer to the header section of the buffer. Point is placed
-at the beginning of the narrowed buffer.
-
address@hidden mail-header-narrow-to-field
address@hidden mail-header-narrow-to-field
-Narrow the buffer to the header under point. Understands continuation
-headers.
-
address@hidden mail-header-fold-field
address@hidden mail-header-fold-field
-Fold the header under point.
-
address@hidden mail-header-unfold-field
address@hidden mail-header-unfold-field
-Unfold the header under point.
-
address@hidden mail-header-field-value
address@hidden mail-header-field-value
-Return the value of the field under point.
-
address@hidden mail-encode-encoded-word-region
address@hidden mail-encode-encoded-word-region
-Encode the address@hidden words in the region. For instance,
address@hidden is encoded as @samp{=?iso-8859-1?q?Na=EFve?=}.
-
address@hidden mail-encode-encoded-word-buffer
address@hidden mail-encode-encoded-word-buffer
-Encode the address@hidden words in the current buffer. This function is
-meant to be called narrowed to the headers of a message.
-
address@hidden mail-encode-encoded-word-string
address@hidden mail-encode-encoded-word-string
-Encode the words that need encoding in a string, and return the result.
-
address@hidden
-(mail-encode-encoded-word-string
- "This is naïve, baby")
address@hidden "This is =?iso-8859-1?q?na=EFve,?= baby"
address@hidden example
-
address@hidden mail-decode-encoded-word-region
address@hidden mail-decode-encoded-word-region
-Decode the encoded words in the region.
-
address@hidden mail-decode-encoded-word-string
address@hidden mail-decode-encoded-word-string
-Decode the encoded words in the string and return the result.
-
address@hidden
-(mail-decode-encoded-word-string
- "This is =?iso-8859-1?q?na=EFve,?= baby")
address@hidden "This is naïve, baby"
address@hidden example
-
address@hidden table
-
-Currently, @code{mail-parse} is an abstraction over @code{ietf-drums},
address@hidden, @code{rfc2045} and @code{rfc2231}. These are documented
-in the subsequent sections.
-
-
-
address@hidden Basic Functions
address@hidden Basic Functions
-
-This chapter describes the basic, ground-level functions for parsing and
-handling. Covered here is parsing @code{From} lines, removing comments
-from header lines, decoding encoded words, parsing date headers and so
-on. High-level functionality is dealt with in the first chapter
-(@pxref{Decoding and Viewing}).
-
address@hidden
-* rfc2045:: Encoding @code{Content-Type} headers.
-* rfc2231:: Parsing @code{Content-Type} headers.
-* ietf-drums:: Handling mail headers defined by RFC822bis.
-* rfc2047:: En/decoding encoded words in headers.
-* time-date:: Functions for parsing dates and manipulating time.
-* qp:: Quoted-Printable en/decoding.
-* base64:: Base64 en/decoding.
-* binhex:: Binhex decoding.
-* uudecode:: Uuencode decoding.
-* yenc:: Yenc decoding.
-* rfc1843:: Decoding HZ-encoded text.
-* mailcap:: How parts are displayed is specified by the @file{.mailcap}
file
address@hidden menu
-
-
address@hidden rfc2045
address@hidden rfc2045
-
-RFC2045 is the ``main'' @acronym{MIME} document, and as such, one would
-imagine that there would be a lot to implement. But there isn't, since
-most of the implementation details are delegated to the subsequent
-RFCs.
-
-So @file{rfc2045.el} has only a single function:
-
address@hidden @code
address@hidden rfc2045-encode-string
address@hidden rfc2045-encode-string
-Takes a parameter and a value and returns a @samp{PARAM=VALUE} string.
address@hidden will be quoted if there are non-safe characters in it.
address@hidden table
-
-
address@hidden rfc2231
address@hidden rfc2231
-
-RFC2231 defines a syntax for the @code{Content-Type} and
address@hidden headers. Its snappy name is @dfn{MIME
-Parameter Value and Encoded Word Extensions: Character Sets, Languages,
-and Continuations}.
-
-In short, these headers look something like this:
-
address@hidden
-Content-Type: application/x-stuff;
- title*0*=us-ascii'en'This%20is%20even%20more%20;
- title*1*=%2A%2A%2Afun%2A%2A%2A%20;
- title*2="isn't it!"
address@hidden example
-
-They usually aren't this bad, though.
-
-The following functions are defined by this library:
-
address@hidden @code
address@hidden rfc2231-parse-string
address@hidden rfc2231-parse-string
-Parse a @code{Content-Type} header and return a list describing its
-elements.
-
address@hidden
-(rfc2231-parse-string
- "application/x-stuff;
- title*0*=us-ascii'en'This%20is%20even%20more%20;
- title*1*=%2A%2A%2Afun%2A%2A%2A%20;
- title*2=\"isn't it!\"")
address@hidden ("application/x-stuff"
- (title . "This is even more ***fun*** isn't it!"))
address@hidden example
-
address@hidden rfc2231-get-value
address@hidden rfc2231-get-value
-Takes one of the lists on the format above and returns
-the value of the specified attribute.
-
address@hidden rfc2231-encode-string
address@hidden rfc2231-encode-string
-Encode a parameter in headers likes @code{Content-Type} and
address@hidden
-
address@hidden table
-
-
address@hidden ietf-drums
address@hidden ietf-drums
-
address@hidden is an IETF working group that is working on the replacement
-for RFC822.
-
-The functions provided by this library include:
-
address@hidden @code
address@hidden ietf-drums-remove-comments
address@hidden ietf-drums-remove-comments
-Remove the comments from the argument and return the results.
-
address@hidden ietf-drums-remove-whitespace
address@hidden ietf-drums-remove-whitespace
-Remove linear white space from the string and return the results.
-Spaces inside quoted strings and comments are left untouched.
-
address@hidden ietf-drums-get-comment
address@hidden ietf-drums-get-comment
-Return the last most comment from the string.
-
address@hidden ietf-drums-parse-address
address@hidden ietf-drums-parse-address
-Parse an address string and return a list that contains the mailbox and
-the plain text name.
-
address@hidden ietf-drums-parse-addresses
address@hidden ietf-drums-parse-addresses
-Parse a string that contains any number of comma-separated addresses and
-return a list that contains mailbox/plain text pairs.
-
address@hidden ietf-drums-parse-date
address@hidden ietf-drums-parse-date
-Parse a date string and return an Emacs time structure.
-
address@hidden ietf-drums-narrow-to-header
address@hidden ietf-drums-narrow-to-header
-Narrow the buffer to the header section of the current buffer.
-
address@hidden table
-
-
address@hidden rfc2047
address@hidden rfc2047
-
-RFC2047 (Message Header Extensions for address@hidden Text) specifies how
address@hidden text in headers are to be encoded. This is actually rather
-complicated, so a number of variables are necessary to tweak what this
-library does.
-
-The following variables are tweakable:
-
address@hidden @code
address@hidden rfc2047-header-encoding-alist
address@hidden rfc2047-header-encoding-alist
-This is an alist of header / encoding-type pairs. Its main purpose is
-to prevent encoding of certain headers.
-
-The keys can either be header regexps, or @code{t}.
-
-The values can be @code{nil}, in which case the header(s) in question
-won't be encoded, @code{mime}, which means that they will be encoded, or
address@hidden, which means the header(s) will be encoded carefully
-assuming they contain addresses.
-
address@hidden rfc2047-charset-encoding-alist
address@hidden rfc2047-charset-encoding-alist
-RFC2047 specifies two forms of address@hidden (a
-Quoted-Printable-like encoding) and @code{B} (base64). This alist
-specifies which charset should use which encoding.
-
address@hidden rfc2047-encode-function-alist
address@hidden rfc2047-encode-function-alist
-This is an alist of encoding / function pairs. The encodings are
address@hidden, @code{B} and @code{nil}.
-
address@hidden rfc2047-encoded-word-regexp
address@hidden rfc2047-encoded-word-regexp
-When decoding words, this library looks for matches to this regexp.
-
address@hidden rfc2047-encode-encoded-words
address@hidden rfc2047-encode-encoded-words
-The boolean variable specifies whether encoded words
-(e.g. @samp{=?hello?=}) should be encoded again.
-
address@hidden table
-
-Those were the variables, and these are this functions:
-
address@hidden @code
address@hidden rfc2047-narrow-to-field
address@hidden rfc2047-narrow-to-field
-Narrow the buffer to the header on the current line.
-
address@hidden rfc2047-encode-message-header
address@hidden rfc2047-encode-message-header
-Should be called narrowed to the header of a message. Encodes according
-to @code{rfc2047-header-encoding-alist}.
-
address@hidden rfc2047-encode-region
address@hidden rfc2047-encode-region
-Encodes all encodable words in the region specified.
-
address@hidden rfc2047-encode-string
address@hidden rfc2047-encode-string
-Encode a string and return the results.
-
address@hidden rfc2047-decode-region
address@hidden rfc2047-decode-region
-Decode the encoded words in the region.
-
address@hidden rfc2047-decode-string
address@hidden rfc2047-decode-string
-Decode a string and return the results.
-
address@hidden rfc2047-encode-parameter
address@hidden rfc2047-encode-parameter
-Encode a parameter in the RFC2047-like style. This is a replacement for
-the @code{rfc2231-encode-string} function. @xref{rfc2231}.
-
-When attaching files as @acronym{MIME} parts, we should use the RFC2231
-encoding to specify the file names containing address@hidden
-characters. However, many mail softwares don't support it in practice
-and recipients won't be able to extract files with correct names.
-Instead, the RFC2047-like encoding is acceptable generally. This
-function provides the very RFC2047-like encoding, resigning to such a
-regrettable trend. To use it, put the following line in your
address@hidden/.gnus.el} file:
-
address@hidden
-(defalias 'mail-header-encode-parameter 'rfc2047-encode-parameter)
address@hidden lisp
-
address@hidden table
-
-
address@hidden time-date
address@hidden time-date
-
-While not really a part of the @acronym{MIME} library, it is convenient to
-document this library here. It deals with parsing @code{Date} headers
-and manipulating time. (Not by using tesseracts, though, I'm sorry to
-say.)
-
-These functions convert between five formats: A date string, an Emacs
-time structure, a decoded time list, a second number, and a day number.
-
-Here's a bunch of time/date/second/day examples:
-
address@hidden
-(parse-time-string "Sat Sep 12 12:21:54 1998 +0200")
address@hidden (54 21 12 12 9 1998 6 nil 7200)
-
-(date-to-time "Sat Sep 12 12:21:54 1998 +0200")
address@hidden (13818 19266)
-
-(time-to-seconds '(13818 19266))
address@hidden 905595714.0
-
-(seconds-to-time 905595714.0)
address@hidden (13818 19266 0)
-
-(time-to-days '(13818 19266))
address@hidden 729644
-
-(days-to-time 729644)
address@hidden (961933 65536)
-
-(time-since '(13818 19266))
address@hidden (0 430)
-
-(time-less-p '(13818 19266) '(13818 19145))
address@hidden nil
-
-(subtract-time '(13818 19266) '(13818 19145))
address@hidden (0 121)
-
-(days-between "Sat Sep 12 12:21:54 1998 +0200"
- "Sat Sep 07 12:21:54 1998 +0200")
address@hidden 5
-
-(date-leap-year-p 2000)
address@hidden t
-
-(time-to-day-in-year '(13818 19266))
address@hidden 255
-
-(time-to-number-of-days
- (time-since
- (date-to-time "Mon, 01 Jan 2001 02:22:26 GMT")))
address@hidden 4.146122685185185
address@hidden example
-
-And finally, we have @code{safe-date-to-time}, which does the same as
address@hidden, but returns a zero time if the date is
-syntactically malformed.
-
-The five data representations used are the following:
-
address@hidden @var
address@hidden date
-An RFC822 (or similar) date string. For instance: @code{"Sat Sep 12
-12:21:54 1998 +0200"}.
-
address@hidden time
-An internal Emacs time. For instance: @code{(13818 26466)}.
-
address@hidden seconds
-A floating point representation of the internal Emacs time. For
-instance: @code{905595714.0}.
-
address@hidden days
-An integer number representing the number of days since 00000101. For
-instance: @code{729644}.
-
address@hidden decoded time
-A list of decoded time. For instance: @code{(54 21 12 12 9 1998 6 t
-7200)}.
address@hidden table
-
-All the examples above represent the same moment.
-
-These are the functions available:
-
address@hidden @code
address@hidden date-to-time
-Take a date and return a time.
-
address@hidden time-to-seconds
-Take a time and return seconds.
-
address@hidden seconds-to-time
-Take seconds and return a time.
-
address@hidden time-to-days
-Take a time and return days.
-
address@hidden days-to-time
-Take days and return a time.
-
address@hidden date-to-day
-Take a date and return days.
-
address@hidden time-to-number-of-days
-Take a time and return the number of days that represents.
-
address@hidden safe-date-to-time
-Take a date and return a time. If the date is not syntactically valid,
-return a ``zero'' time.
-
address@hidden time-less-p
-Take two times and say whether the first time is less (i. e., earlier)
-than the second time.
-
address@hidden time-since
-Take a time and return a time saying how long it was since that time.
-
address@hidden subtract-time
-Take two times and subtract the second from the first. I. e., return
-the time between the two times.
-
address@hidden days-between
-Take two days and return the number of days between those two days.
-
address@hidden date-leap-year-p
-Take a year number and say whether it's a leap year.
-
address@hidden time-to-day-in-year
-Take a time and return the day number within the year that the time is
-in.
-
address@hidden table
-
-
address@hidden qp
address@hidden qp
-
-This library deals with decoding and encoding Quoted-Printable text.
-
-Very briefly explained, qp encoding means translating all 8-bit
-characters (and lots of control characters) into things that look like
address@hidden; that is, an equal sign followed by the byte encoded as a hex
-string.
-
-The following functions are defined by the library:
-
address@hidden @code
address@hidden quoted-printable-decode-region
address@hidden quoted-printable-decode-region
-QP-decode all the encoded text in the specified region.
-
address@hidden quoted-printable-decode-string
address@hidden quoted-printable-decode-string
-Decode the QP-encoded text in a string and return the results.
-
address@hidden quoted-printable-encode-region
address@hidden quoted-printable-encode-region
-QP-encode all the encodable characters in the specified region. The third
-optional parameter @var{fold} specifies whether to fold long lines.
-(Long here means 72.)
-
address@hidden quoted-printable-encode-string
address@hidden quoted-printable-encode-string
-QP-encode all the encodable characters in a string and return the
-results.
-
address@hidden table
-
-
address@hidden base64
address@hidden base64
address@hidden base64
-
-Base64 is an encoding that encodes three bytes into four characters,
-thereby increasing the size by about 33%. The alphabet used for
-encoding is very resistant to mangling during transit.
-
-The following functions are defined by this library:
-
address@hidden @code
address@hidden base64-encode-region
address@hidden base64-encode-region
-base64 encode the selected region. Return the length of the encoded
-text. Optional third argument @var{no-line-break} means do not break
-long lines into shorter lines.
-
address@hidden base64-encode-string
address@hidden base64-encode-string
-base64 encode a string and return the result.
-
address@hidden base64-decode-region
address@hidden base64-decode-region
-base64 decode the selected region. Return the length of the decoded
-text. If the region can't be decoded, return @code{nil} and don't
-modify the buffer.
-
address@hidden base64-decode-string
address@hidden base64-decode-string
-base64 decode a string and return the result. If the string can't be
-decoded, @code{nil} is returned.
-
address@hidden table
-
-
address@hidden binhex
address@hidden binhex
address@hidden binhex
address@hidden Apple
address@hidden Macintosh
-
address@hidden is an encoding that originated in Macintosh environments.
-The following function is supplied to deal with these:
-
address@hidden @code
address@hidden binhex-decode-region
address@hidden binhex-decode-region
-Decode the encoded text in the region. If given a third parameter, only
-decode the @code{binhex} header and return the filename.
-
address@hidden table
-
address@hidden uudecode
address@hidden uudecode
address@hidden uuencode
address@hidden uudecode
-
address@hidden is probably still the most popular encoding of binaries
-used on Usenet, although @code{base64} rules the mail world.
-
-The following function is supplied by this package:
-
address@hidden @code
address@hidden uudecode-decode-region
address@hidden uudecode-decode-region
-Decode the text in the region.
address@hidden table
-
-
address@hidden yenc
address@hidden yenc
address@hidden yenc
-
address@hidden is used for encoding binaries on Usenet. The following
-function is supplied by this package:
-
address@hidden @code
address@hidden yenc-decode-region
address@hidden yenc-decode-region
-Decode the encoded text in the region.
-
address@hidden table
-
-
address@hidden rfc1843
address@hidden rfc1843
address@hidden rfc1843
address@hidden HZ
address@hidden Chinese
-
-RFC1843 deals with mixing Chinese and @acronym{ASCII} characters in messages.
In
-essence, RFC1843 switches between @acronym{ASCII} and Chinese by doing this:
-
address@hidden
-This sentence is in @acronym{ASCII}.
-The next sentence is in address@hidden<:Ky2;address@hidden,NpJ)address@hidden
address@hidden example
-
-Simple enough, and widely used in China.
-
-The following functions are available to handle this encoding:
-
address@hidden @code
address@hidden rfc1843-decode-region
-Decode HZ-encoded text in the region.
-
address@hidden rfc1843-decode-string
-Decode a HZ-encoded string and return the result.
-
address@hidden table
-
-
address@hidden mailcap
address@hidden mailcap
-
-The @file{~/.mailcap} file is parsed by most @acronym{MIME}-aware message
-handlers and describes how elements are supposed to be displayed.
-Here's an example file:
-
address@hidden
-image/*; gimp -8 %s
-audio/wav; wavplayer %s
-application/msword; catdoc %s ; copiousoutput ; nametemplate=%s.doc
address@hidden example
-
-This says that all image files should be displayed with @code{gimp},
-that WAVE audio files should be played by @code{wavplayer}, and that
-MS-WORD files should be inlined by @code{catdoc}.
-
-The @code{mailcap} library parses this file, and provides functions for
-matching types.
-
address@hidden @code
address@hidden mailcap-mime-data
address@hidden mailcap-mime-data
-This variable is an alist of alists containing backup viewing rules.
-
address@hidden table
-
-Interface functions:
-
address@hidden @code
address@hidden mailcap-parse-mailcaps
address@hidden mailcap-parse-mailcaps
-Parse the @file{~/.mailcap} file.
-
address@hidden mailcap-mime-info
-Takes a @acronym{MIME} type as its argument and returns the matching viewer.
-
address@hidden table
-
-
-
-
address@hidden Standards
address@hidden Standards
-
-The Emacs @acronym{MIME} library implements handling of various elements
-according to a (somewhat) large number of RFCs, drafts and standards
-documents. This chapter lists the relevant ones. They can all be
-fetched from @uref{http://quimby.gnus.org/notes/}.
-
address@hidden @dfn
address@hidden RFC822
address@hidden STD11
-Standard for the Format of ARPA Internet Text Messages.
-
address@hidden RFC1036
-Standard for Interchange of USENET Messages
-
address@hidden RFC2045
-Format of Internet Message Bodies
-
address@hidden RFC2046
-Media Types
-
address@hidden RFC2047
-Message Header Extensions for address@hidden Text
-
address@hidden RFC2048
-Registration Procedures
-
address@hidden RFC2049
-Conformance Criteria and Examples
-
address@hidden RFC2231
address@hidden Parameter Value and Encoded Word Extensions: Character Sets,
-Languages, and Continuations
-
address@hidden RFC1843
-HZ - A Data Format for Exchanging Files of Arbitrarily Mixed Chinese and
address@hidden characters
-
address@hidden draft-ietf-drums-msg-fmt-05.txt
-Draft for the successor of RFC822
-
address@hidden RFC2112
-The @acronym{MIME} Multipart/Related Content-type
-
address@hidden RFC1892
-The Multipart/Report Content Type for the Reporting of Mail System
-Administrative Messages
-
address@hidden RFC2183
-Communicating Presentation Information in Internet Messages: The
-Content-Disposition Header Field
-
address@hidden RFC2646
-Documentation of the text/plain format parameter for flowed text.
-
address@hidden table
-
address@hidden GNU Free Documentation License
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
-
address@hidden Index
address@hidden Index
address@hidden cp
-
address@hidden
address@hidden
address@hidden
-
-
address@hidden Local Variables:
address@hidden mode: texinfo
address@hidden coding: iso-8859-1
address@hidden End:
-
address@hidden
- arch-tag: c7ef2fd0-a91c-4e10-aa52-c1a2b11b1a8d
address@hidden ignore
- [Emacs-diffs] Changes to emacs-mime.texi,
Glenn Morris <=