annotate doc/misc/emacs-mime.texi @ 112328:ba9f26694b92

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