MHonArc
view release on metacpan or search on metacpan
4594 Initial space on lines removed when using fancyquote.
------ ------------------------------------------------------------
<https://savannah.nongnu.org/bugs/?group=mhonarc>
* Added LANG resource to define locale. Affects resource filename
resolution and message subject and author sorting.
* readmail.pl updated to define the following special header field
keys passed to filter routines:
x-mha-content-type The media type of the entity extracted from
content-type entity header
x-mha-part-number The relative part number of the entity with
respect to parent entity. To get the
absolute part number, use
readmail::get_full_part_number($fields).
x-mha-parent-header Reference to parent header fields hash.
This, and other data structures, are now mentioned in the MIMEFILTERS
resource page.
* Text/richtext tag, <samepage>, is quietly dropped in mhtxtenrich.pl.
When a resource variable is being expanded.
See API appendix of the documentation for more information.
* mha-decode now supports the following option: -dcd-digest. This
tells mha-decode to not recursively process attached message/rfc822
and message/news entities. This option is useful to extract
out all the individual messages of a message digest.
* Added message/rfc822 and message/news to mhmimetypes.pl
content-type => extension/description hash. The extension used
is ".822".
* Added ISO-8859-15 to default value of CHARSETCONVERTERS. This should
have been done in the previous release.
* A readmail:: variable is not written to database file if it is
the default value. The readmail:: variables that can be saved
are controled by the CHARSETCONVERTERS, MIMEFILTERS, and MIMEARGS
resources.
o Default value for MIMEArgs has been changed to the following:
<MIMEArgs>
m2h_external::filter; inline
</MIMEArgs>
This is more concise then previous default value.
On a resource file maintenance standpoint, it is generally
best to specify filter arguments at the filter level and
not at the content-type level.
o Value of Perl's $^O variable printed with version information
for -V, -v, -help command-line options.
o The count of new messages added to archive are now printed
along with the total message count when QUIET is not active.
============================================================================
2001/09/05 (2.5.0b2)
($html, @files) =
&filter($fields_hash_ref, $body_data_ref, $is_decoded,
$filter_args);
Paramaters:
$fields_hash_ref
A reference to hash of message/part header
fields. Keys are field names in lowercase
and values are array references containing the
field values. For example, to obtain the
content-type, if defined, you would do:
$fields_hash_ref->{'content-type'}[0]
Values for a fields are stored in arrays since
duplication of fields are possible. For example,
the Received: header field is typically repeated
multiple times. For fields that only occur once,
then array for the field will only contain one
item.
$body_data_ref
Reference to body data. It is okay for the
API changes to MIMEFILTERS registered routines). However,
if you have mucked with MHonArc internals, or created custom
modifications, you may need to be aware that changes have
been made.
============================================================================
2001/06/10 (2.4.9)
o Added the following resources:
MIMEEXCS List of content-types to exclude
from processing. Exclusion occurs
before data is passed to filters.
o mhtxtplain.pl: If decoding uuencoded data, the data will
be excluded if application/octet-stream is listed the
MIMEEXCS resource.
o mhtxthtml.pl: If a CID URL is not available, the CID URL
is no longer preserved in the converted output. The CID
URL is stripped.
o Added the following to mhmimetypes.pl content-type table:
application/ms-excel => xls:MS-Excel spreadsheet
application/ms-powerpoint => ppt:MS-Powerpoint presentation
application/ms-project => mpp:MS-Project file
The "vnd." official versions are already present, but
some application use the above.
o TODO list added to distribution.
o m2h_external::filter new arguments:
excludeexts=ext1,...
A comma separated list of message specified filename
extensions to exclude. I.e. If the filename
extension matches an extension in excludeexts, the
content will not be written. The return markup
will contain the name of the attachment, but no
link to the data. This option is best used with
application/octet-stream to exclude unwanted data
that is not tagged with the proper content-type.
The m2h_null::filter can be used to exclude content
by content-type.
o m2h_null::filter will now output a one line description
of the excluded content. This is so the reader knows that
there was message content not saved within the archive.
o m2h_text_plain::filter new arguments:
usename If extracting uuencoded data, the filename
specified should be used.
o New resource variables
$TSLICE$ - Print thread listing slice relative to
current message.
o Added default=charset option to mhtxtplain.pl filter.
o Added mhtxttsv.pl to handle text/tab-separated-values
content.
o Expanded list of recognized content-types in mhexternal.pl.
o Changed loading of decoders, charset convertes, and
content-type filters to be done on demand. Should
provide an increase in start-up time.
o Modified source so no Perl structures are in the "main"
package. The base package is now "mhonarc". This
should make it easier for incorporating mhonarc into
another Perl program.
*IMPORTANT*: This change causes changes to db file format.
See release notes on how to upgrade pre v2.2 archives.
MSGPREFIX Prefix for message filenames
REFSBEGIN Begin markup for message references
REFSEND End markup for message references
REFSLITXT Markup for reference list entry
TSORT Sort threads by date or message number
TSUBSORT Sort threads by subject
o Changes to mhexternal.pl filter:
- Two new options: useicons and iconurl="url".
- Added some more content-types to CTExt hash.
o Added filter for text/enriched data (mhtxtenrich.pl).
o Changed default setting for MIMEFILTERS. The following
was added:
model/*:m2h_external'filter:mhexternal.pl
text/enriched:m2h_text_enriched'filter:mhtxtenrich.pl
text/richtext:m2h_text_enriched'filter:mhtxtenrich.pl
o Support for user defined derived files for messages.
o Support for the Content-Length field.
o Modification time of messages, and derived files, can be
set to the Received/Date time specified in the message.
o More control on how mail headers get formatted.
o Added filter in mhexternal.pl to be the default filter
for main content-types: application, image, video, audio.
o List of enhancements to mhexternal.pl:
- Show content-type if the data is not recognized.
- New `ext' filter option to define the extension to
use for the created file.
- New `type' filter option to define the "english"
type name of the create file.
- Content-Disposition is supported. Filenames are
ignored still unless `usename' argument passed to
filter.
- Added recognition of few more content-types
o Updated date parsing to figure out the date of a message to be
more robust on how it parses a date. If unable to parse
date, the message will take on the current time for sorting
purposes. Also, character case is ignored in month and weekday
names.
o The comment declaration "<!--X-Body-of-Message-->" is
now inserted between the message header and body. Helps
in the building of some search indexes to restrict searches
=======================================================================
1996/03/22 (1.2.1)
o Added support for x-uuencode content-transfer-encoding.
o Added -locktries command-line option.
o Added the resource variable $OUTDIR$.
o mhexternal.pl filter will use the name parameter string
on the content-type field as the anchor text to the file
if there is no content-description.
o application/x-patch is recognized and processed by the
text/plain filter (mhtxtplain.pl).
o Fixed bug in install.me and osinit.pl where setting
$'PROG caused perl to terminate if $'DIRSEP was a backslash
(occured under MS-DOS usage).
o Fixed bug in install.me in the create_dir routine.
image/*:myfilter'imagefilter:myfilter.pl
image/gif:myfilter'giffilter:myfilter.pl
</mimefilters>
"myfilter'giffilter" is called for all image/gif data.
"myfilter'imagefilter" is called for all other image data.
o A new resource, MIMEARGS, may be used to pass optional arguments
to filters to control their behavior. The format of the
argument string is controlled by the various filters. The
arguments can be specified by a specific content-type, or
for the filter routine in general. A content-type argument
will be used over any arguments specified for a filter.
Example usage:
<mimeargs>
image/gif:inline usename
m2h_external'filter:usename
</mimeargs>
See the documentation for possible arguments to filters.
o Fixed problem with messages (with follow-ups) getting
unnecessarily updated when messages are added to an archive.
o Only a CR/LF, or LF, pair will terminate a message head.
Before, MHonArc was terminating message heads when
encountering an empty line or a line that only contained
whitespace (which was incorrect behavior).
o Fixed bug in mhexternal.pl dealing with the `name' parameter
in the content-type field. Surrounding "s or 's were not
being deleted causing filenames with quotes to be written.
o mhexternal.pl: The head of a pathname in the `name'
parameter in the content-type field is stripped off before
writing the external file. I.e. Only the base filename is
used.
o Only one <HR> after the H1 subject in messages will appear
if no message header fields are printed.
o Added recognition of the following content-types in
mhexternal.pl:
application/mac-binhex40
o Added a extras/ directory containing useful programs for
MHonArc. See README in the directory for information on
the programs contained in there.
o To support -rmm, MIME filters now return an array. The
first array value is the HTML for the message, and any other
contrib/mhn2mbox.pl view on Meta::CPAN
if (defined($href->{'reference'})) {
print MBOXFILE "In-Reply-To: <$href->{'reference'}[0]>\n";
}
if (defined($href->{'message-id'})) {
print MBOXFILE "Message-ID: <$href->{'message-id'}[0]>\n";
}
print MBOXFILE "MIME-Version: 1.0\n";
if (defined($href->{'content-type'})) {
$contype = $href->{'content-type'}[0];
} elsif (defined($href->{'contenttype'})) { # older versions
$contype = $href->{'contenttype'}[0];
}
if (defined($href->{'msgbodytext'})) {
push(@bodytext, @{$href->{'msgbodytext'}});
}
if ($contype =~ /multipart/i) {
$boundary = join("", $$, '.', time, '.', $contype);
doc/app-api.html view on Meta::CPAN
is controled by the <a href="resources/fromfields.html">FROMFIELDS</a>
resource.
</dd>
<dt><tt>x-mha-subject</tt></dt>
<dd>The message subject that will be used by MHonArc. The
value may be different from the raw subject text of the message
since <a href="resources/subjectstripcode.html">SUBJECTSTRIPCODE</a>
code will have been applied.
If no subject is defined, then the value is the empty string.
</dd>
<dt><tt>x-mha-content-type</tt></dt>
<dd>The content-type of the message MHonArc will use for
the message.
</dd>
</dl>
<p>For example, to access the subject text that MHonArc will use,
do the following:
<code>$fields_hash_ref->{'x-mha-subject'};</code>
</p>
</dd>
<dt><tt>$raw_header_txt</tt></dt>
doc/app-api.html view on Meta::CPAN
<h2><a name="utilities">Utility Routines</a></h2>
<p>The following are various utility routines available for use by
custom extensions and <a href="resources/mimefilters.html">filters</a>:
</p>
<!-- .................................................................. -->
<h3 class="cb_head"><a name="mhonarc::get_icon_url">mhonarc::get_icon_url</a></h3>
<div class="cb_body">
<p>Retrieve icon URL for a give content-type as defined by the
<a href="resources/icons.html">ICONS</a> resource.
</p>
<p><b>Synopsis:</b></p>
<pre class="code">
$url = mhonarc::get_icon_url($content_type);
</pre>
<p><b>Arguments:</b></p>
<dl>
<dt><tt>$content_type</tt></dt>
<dd><p>MIME content-type to retrieve icon for.
</p>
</dd>
</dl>
<p><b>Return Value:</b></p>
<p>URL to icon.
</p>
</div>
<!-- .................................................................. -->
doc/app-api.html view on Meta::CPAN
<p><b>Return Value:</b></p>
<p>The converted htmlized text.
</p>
</div>
<!-- .................................................................. -->
<h3 class="cb_head"><a name="mhonarc::write_attachment">mhonarc::write_attachment</a></h3>
<div class="cb_body">
<p>Saves data to a file with a specified content-type.
</p>
<p><b>Synopsis:</b></p>
<pre class="code">
require 'mhmimetypes.pl';
($filename, $url) =
mhonarc::write_attachment($content_type, $data_ref, $options_hash_ref);
</pre>
<p><b>Arguments:</b></p>
<dl>
<dt><tt>$content_type</tt></dt>
<dd><p>The content-type of the data. The value should be a string
in standard MIME content-type format. Examples: <tt>images/jpeg</tt>,
<tt>application/postscript</tt>.
</p>
</dd>
<dt><tt>$data_ref</tt></dt>
<dd><p>Scalar reference of data to write to disk.
</p>
</dd>
<dt><tt>$options_hash_ref</tt></dt>
doc/app-api.html view on Meta::CPAN
'-filename' => $name,
'-ext' => $ext,
});
</pre>
<p><b>Notes:</b></p>
<ul>
<li><p>Care should practiced when using the <tt>-filename</tt> or
<tt>-ext</tt> option since it could result in security vulnerabilities.
When these options are not specified, <tt>mhonarc::write_attachment</tt>
will created a safe random filename based upon the given content-type.
</p>
</ul>
</div>
<!-- .................................................................. -->
<h3 class="cb_head"><a name="readmail::MAILhead_get_disposition">readmail::MAILhead_get_disposition</a></h3>
<div class="cb_body">
<p>Retrieve the content disposition of a message entity.
</p>
doc/app-mimeconf.html view on Meta::CPAN
</li>
<li><p>
Must treat any unrecognized Content-Transfer-Encoding
as if it had a Content-Type of "application/octet-stream", regardless of whether or not the actual
Content-Type is recognized.
</p>
<table border=0 cellpadding=4>
<tr valign=top>
<td><strong><img src="monicon.png" alt="MHonArc"></strong></td>
<td><p>Currently, MHonArc will still call the registered
<a href="resources/mimefilters.html">content-type filter</a> for the specified
Content-Type, but the <b><tt>$isdecoded</tt></b> will be set to a false
value. With the default set of filters, the <b><tt>$isdecoded</tt></b>
flag is ignored. Therefore, behavior could be considered undefined when
MHonArc process a message with an unrecognized Content-Transfer-Encoding.
</p>
</td>
</tr>
</table>
</li>
<li><p>
doc/app-rcidx.html view on Meta::CPAN
<tr valign="top"><td align="right"><b><a href="resources/lockmethod.html"><tt><LOCKMETHOD></tt></a></b></td><td></td><td>How archive locks are done.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mailto.html"><tt><MAILTO></tt><br><tt><NOMAILTO></tt></a></b></td><td></td><td>Convert email addresses in message headers to hyperlinks.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mailtourl.html"><tt><MAILTOURL></tt></a></b></td><td></td><td>URL template to use when MAILTO is set.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/main.html"><tt><MAIN></tt><br><tt><NOMAIN></tt></a></b></td><td></td><td>Create main index.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/maxsize.html"><tt><MAXSIZE></tt></a></b></td><td></td><td>Maximum number of messages in an archive.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mhpattern.html"><tt><MHPATTERN></tt></a></b></td><td></td><td>Regex for matching message files in an MH folder (directory).</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mimealtprefs.html"><tt><MIMEALTPREFS></tt></a></b></td><td></td><td>Content-type preferences for multipart/alternative data.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mimeargs.html"><tt><MIMEARGS></tt></a></b></td><td></td><td>Arguments to MIME filters.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mimedecoders.html"><tt><MIMEDECODERS></tt></a></b></td><td></td><td>Content-Transfer-Encoding decoding functions.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mimeexcs.html"><tt><MIMEEXCS></tt></a></b></td><td></td><td>Content-types to exclude.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mimefilters.html"><tt><MIMEFILTERS></tt></a></b></td><td></td><td>Mapping of MIME filters to content-types.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/mimeincs.html"><tt><MIMEINCS></tt></a></b></td><td></td><td>Content-types to allow.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/modifybodyaddresses.html"><tt><MODIFYBODYADDRESSES></tt><br><tt><NOMODIFYBODYADDRESSES></tt></a></b></td><td></td><td>Apply ADDRESSMODIFYCODE to text message bodies.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/modtime.html"><tt><MODTIME></tt></a></b></td><td></td><td>Set modification time on message files to message dates.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/months.html"><tt><MONTHS></tt></a></b></td><td></td><td>Month names.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/monthsabr.html"><tt><MONTHSABR></tt></a></b></td><td></td><td>Abbreviated month names.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/msgbodyend.html"><tt><MSGBODYEND></tt></a></b></td><td></td><td>Markup after the message body.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/msgexcfilter.html"><tt><MSGEXCFILTER></tt></a></b></td><td></td><td>Perl expression(s) to selectively exclude messages.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/msgfoot.html"><tt><MSGFOOT></tt></a></b></td><td></td><td>Markup at the foot of each message page.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/msggmtdatefmt.html"><tt><MSGGMTDATEFMT></tt></a></b></td><td></td><td>GMT conversion specification for message dates.</td></tr>
<tr valign="top"><td align="right"><b><a href="resources/msghead.html"><tt><MSGHEAD></tt></a></b></td><td></td><td>Markup at the head of each message page.</td></tr>
doc/app-utilsprg.html view on Meta::CPAN
<H2><a name="mha-decode">mha-decode</a></H2>
<P><b>mha-decode</b> is a utility program unrelated to MHonArc archives.
<b>mha-decode</b> provides basic MIME decoding capabilites for
messages.
</P>
<p>If given mail folders as input, all messages within in the mail
folders will be decoded. All message parts are written to files. If a
filename is specified for a message part, that filename will be used
when writing the part to a file. If no filename is specified in the
message, a unique name will be used based upon the content-type of
the message part.
</p>
<p>A single message can be decoded by using the <tt>-single</tt> option.
</p>
Only MHonArc options that affect parsing of mail folders are applicable
for <b>mha-decode</b>. The following options are applicable:
<tt>-conlen</tt>,
<tt>-mhpattern</tt>,
<tt>-msgsep</tt>,
doc/faq/faq.html view on Meta::CPAN
<li><a name="howthreads" href="threads.html#howthreads">How does threading work?</a></li>
<li><a name="whynotthreads" href="threads.html#whynotthreads">Why isn't threading working for me?</a></li>
<li><a name="refsinmua" href="threads.html#refsinmua">How can I get my MUA to define the References or In-Reply-To field? </a></li>
</ul>
</ul>
<ul>
<li><a name="mime" href="mime.html">MIME</a>
<ul>
<li><a name="whatismime" href="mime.html#whatismime">What is MIME?</a></li>
<li><a name="nonascii" href="mime.html#nonascii">Does MHonArc support message header extensions for non-ASCII text?</a></li>
<li><a name="howtorecog" href="mime.html#howtorecog">How can I get MHonArc to recognize content-types it states it does not recognize?</a></li>
<li><a name="overridedefs" href="mime.html#overridedefs">Can I override the default filters in MHonArc?</a></li>
<li><a name="overridemulti" href="mime.html#overridemulti">Can I override the multipart/* processing of MHonArc?</a></li>
<li><a name="badtype" href="mime.html#badtype">Why are attachments saved as a ".bin" files?</a></li>
<li><a name="filenames" href="mime.html#filenames">Can attachments get saved with the filename specified in the message header?</a></li>
<li><a name="removepre" href="mime.html#removepre">Can the <PRE> tags be removed from converted messages?</a></li>
<li><a name="lineclip" href="mime.html#lineclip">Can long lines be wrapped in converted messages?</a></li>
<li><a name="exclude" href="mime.html#exclude">Can I exclude specific media-types?</a></li>
<li><a name="alternative" href="mime.html#alternative">Can I tell MHonArc to use the text/plain part over a text/html part in a multipart/alternative message?</a></li>
<li><a name="excattach" href="mime.html#excattach">How do I exclude attachments from my archives?</a></li>
</ul>
doc/faq/indexpgs.html view on Meta::CPAN
<hr noshade size=1>
<table border=0>
<tr valign=baseline><td><img src="monicon.png" align="bottom" alt=""></td><td>
<h3><b><a name="attachments">Can I include links to message attachments on index pages?</a></b></h3>
</td></tr></table>
<p>Not directly, but a (dirty) work-around maybe possible.
You can modify the
mhexternal.pl filter to write to a file (name based off the message
number) with some HTML markup that creates the HTML attachment list
(mhexternal.pl knows about content-types and other stuff, so it can
make a useful list). Note, since mhexternal.pl works on a single part
at a time, it needs to create the list via append operations to the
file. The implementation is similiar to how mhexternal.pl supports
placing attachments into a subdirectory. Make sure that mhexternal.pl
returns the file as part of the return value so it is automatically
deleted if the message is removed from the archive.
</p>
<p>Then, you define the <a href="../resources/litemplate.html">LITEMPLATE</a>
resource to use a server-side include
to include the file as part of the message listing. I did say
doc/faq/mime.html view on Meta::CPAN
<!--X-NavButtons-End-->
<!-- ===================================================================== -->
<HR>
<H2><a name="mime">MIME</a></H2>
<!--X-TOC-Start-->
<ul>
<li><a href="#whatismime">What is MIME?</a></li>
<li><a href="#nonascii">Does MHonArc support message header extensions for non-ASCII text?</a></li>
<li><a href="#howtorecog">How can I get MHonArc to recognize content-types it states it does not recognize?</a></li>
<li><a href="#overridedefs">Can I override the default filters in MHonArc?</a></li>
<li><a href="#overridemulti">Can I override the multipart/* processing of MHonArc?</a></li>
<li><a href="#badtype">Why are attachments saved as a ".bin" files?</a></li>
<li><a href="#filenames">Can attachments get saved with the filename specified in the message header?</a></li>
<li><a href="#removepre">Can the <PRE> tags be removed from converted messages?</a></li>
<li><a href="#lineclip">Can long lines be wrapped in converted messages?</a></li>
<li><a href="#exclude">Can I exclude specific media-types?</a></li>
<li><a href="#alternative">Can I tell MHonArc to use the text/plain part over a text/html part in a multipart/alternative message?</a></li>
<li><a href="#excattach">How do I exclude attachments from my archives?</a></li>
</ul>
doc/faq/mime.html view on Meta::CPAN
<P>v2.0 or later. Review the <a href="../resources/charsetconverters.html">CHARSETCONVERTERS</a> resource page for
which character sets are supported by MHonArc and how to extend
MHonArc to support other character sets.
</P>
<!-- ??????????????????????????????????????????????????????????????? -->
<hr noshade size=1>
<table border=0>
<tr valign=baseline><td><img src="monicon.png" align="bottom" alt=""></td><td>
<h3><b><a name="howtorecog">How can I get MHonArc to recognize content-types it states it does not recognize?</a></b></h3>
</td></tr></table>
<P>This question can be answered by reading about the <a href="../resources/mimefilters.html">MIMEFILTERS</a>
resource of the
MHonArc documentation. The solution may require registering
a pre-existing filter for the given content-type, or hooking in a
new filter.
</P>
<table class="note" width="100%">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
<td width="100%"><p>MHonArc treats unknown content-types as
<tt>application/octet-stream</tt> for purposes of filtering.
</p>
</td>
</tr>
</table>
<p>
</p>
<!-- ??????????????????????????????????????????????????????????????? -->
<hr noshade size=1>
doc/faq/mime.html view on Meta::CPAN
<!-- ??????????????????????????????????????????????????????????????? -->
<hr noshade size=1>
<table border=0>
<tr valign=baseline><td><img src="monicon.png" align="bottom" alt=""></td><td>
<h3><b><a name="badtype">Why are attachments saved as a ".bin" files?</a></b></h3>
</td></tr></table>
<p>MHonArc uses the <b>Content-Type</b> field in messages to determine
the type of data that is being processed. If data is gettings saved
to a "<tt>.bin</tt>" file, it means the data has a content-type of
<b>application/octet-stream</b>. The best solution to the problem
is have the senders of the messages label the data properly. You
can also check out the <b><tt>m2h_external::filter</tt></b> options documented
in the <a href="../resources/mimefilters.html">MIMEFILTERS</a> page of the documentation for some alternate
solutions.
</p>
<!-- ??????????????????????????????????????????????????????????????? -->
<hr noshade size=1>
<table border=0>
doc/faq/msgpgs.html view on Meta::CPAN
controlling message header formatting.
</p>
<!-- ??????????????????????????????????????????????????????????????? -->
<hr noshade size=1>
<table border=0>
<tr valign=baseline><td><img src="monicon.png" align="bottom" alt=""></td><td>
<h3><b><a name="msgbody">How can I change how message body data gets formatted?</a></b></h3>
</td></tr></table>
<p>Message body conversion are controlled by content-type filters.
See the <a href="mime.html">MIME</a> section of this FAQ for
more information.
</p>
<!-- ??????????????????????????????????????????????????????????????? -->
<hr noshade size=1>
<table border=0>
<tr valign=baseline><td><img src="monicon.png" align="bottom" alt=""></td><td>
<h3><b><a name="headnbody">Can I have the message header come after the body?</a></b></h3>
</td></tr></table>
doc/rcfileexs/def-mime.mrc.html view on Meta::CPAN
<!-- $Id: def-mime.mrc,v 1.25 2003/10/06 22:04:23 ehood Exp $
Earl Hood <earl @ earlhood . com>
-->
<!-- MHonArc Resource File --
-- --
-- Description: --
-- Default resource settings related to MIME processing --
-- -->
<!-- ================================================================== -->
<!-- MIMEFILTERS maps content-types to converter functions.
-->
<b><a href="../resources/mimefilters.html"><MIMEFilters></a></b>
application/ms-tnef; m2h_null::filter; mhnull.pl
application/octet-stream; m2h_external::filter; mhexternal.pl
application/*; m2h_external::filter; mhexternal.pl
application/x-patch; m2h_text_plain::filter; mhtxtplain.pl
audio/*; m2h_external::filter; mhexternal.pl
chemical/*; m2h_external::filter; mhexternal.pl
model/*; m2h_external::filter; mhexternal.pl
image/*; m2h_external::filter; mhexternal.pl
doc/rcfileexs/def-mime.mrc.html view on Meta::CPAN
x-sun-attachment; m2h_text_plain::filter; mhtxtplain.pl
<b></MIMEFilters></b>
<!-- MIMEARGS defines arguments to pass to filters registered via
MIMEFILTERS.
-->
<b><a href="../resources/mimeargs.html"><MIMEArgs></a></b>
m2h_external::filter; inline
<b></MIMEArgs></b>
<!-- MIMEALTPREFS defines content-type preferences for
multipart/alternative messages.
-->
<b><a href="../resources/mimealtprefs.html"><MIMEAltPrefs></a></b>
<b></MIMEAltPrefs></b>
<!-- MIMEDECODERS defines functions that decode data according
to an entitie's Content-Transfer-Encoding.
-->
<b><a href="../resources/mimedecoders.html"><MIMEDecoders></a></b>
7bit; as-is;
doc/rcvars.html view on Meta::CPAN
</tr>
</table><br></dd>
<dt><strong><a name="ICON"><tt>$ICON$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The content-type sensistive icon. The type of icon displayed
is determined by the <a href="resources/icons.html">ICONS</a> resource.</td>
</tr>
</table><br></dd>
<dt><strong><a name="ICONURL"><tt>$ICONURL$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
<td><tt><i><a href="#mesg_spec">mesg_spec</a></i></tt></td>
</tr>
<tr valign=top>
<td align=right><b>Description:</b></td>
<td>The URL to the content-type sensistive icon. The URL value is
determined by the
<a href="resources/icons.html">ICONS</a> and
<a href="resources/iconurlprefix.html">ICONURLPREFIX</a>
resources.</td>
</tr>
</table><br></dd>
<dt><strong><a name="ICONURLPREFIX"><tt>$ICONURLPREFIX$</tt></a></strong></dt>
<dd><table border=0>
<tr valign=top>
<td align=right><b>Arguments:</b></td>
doc/resources.html view on Meta::CPAN
<tr valign="top"><td align="right"><b><a name="locktries" href="resources/locktries.html">LOCKTRIES</a></b></td><td></td><td>Total number of time to attempt a lock before failing.</td></tr>
<tr valign="top"><td align="right"><b><a name="mailto" href="resources/mailto.html">MAILTO</a></b></td><td></td><td>Convert email addresses in message headers to hyperlinks.</td></tr>
<tr valign="top"><td align="right"><b><a name="mailtourl" href="resources/mailtourl.html">MAILTOURL</a></b></td><td></td><td>URL template to use when MAILTO is set.</td></tr>
<tr valign="top"><td align="right"><b><a name="main" href="resources/main.html">MAIN</a></b></td><td></td><td>Create main index.</td></tr>
<tr valign="top"><td align="right"><b><a name="maxsize" href="resources/maxsize.html">MAXSIZE</a></b></td><td></td><td>Maximum number of messages in an archive.</td></tr>
<tr valign="top"><td align="right"><b><a name="mhpattern" href="resources/mhpattern.html">MHPATTERN</a></b></td><td></td><td>Regex for matching message files in an MH folder (directory).</td></tr>
<tr valign="top"><td align="right"><b><a name="mimealtprefs" href="resources/mimealtprefs.html">MIMEALTPREFS</a></b></td><td></td><td>Content-type preferences for multipart/alternative data.</td></tr>
<tr valign="top"><td align="right"><b><a name="mimeargs" href="resources/mimeargs.html">MIMEARGS</a></b></td><td></td><td>Arguments to MIME filters.</td></tr>
<tr valign="top"><td align="right"><b><a name="mimedecoders" href="resources/mimedecoders.html">MIMEDECODERS</a></b></td><td></td><td>Content-Transfer-Encoding decoding functions.</td></tr>
<tr valign="top"><td align="right"><b><a name="mimeexcs" href="resources/mimeexcs.html">MIMEEXCS</a></b></td><td></td><td>Content-types to exclude.</td></tr>
<tr valign="top"><td align="right"><b><a name="mimefilters" href="resources/mimefilters.html">MIMEFILTERS</a></b></td><td></td><td>Mapping of MIME filters to content-types.</td></tr>
<tr valign="top"><td align="right"><b><a name="mimeincs" href="resources/mimeincs.html">MIMEINCS</a></b></td><td></td><td>Content-types to allow.</td></tr>
<tr valign="top"><td align="right"><b><a name="modifybodyaddresses" href="resources/modifybodyaddresses.html">MODIFYBODYADDRESSES</a></b></td><td></td><td>Apply ADDRESSMODIFYCODE to text message bodies.</td></tr>
<tr valign="top"><td align="right"><b><a name="modtime" href="resources/modtime.html">MODTIME</a></b></td><td></td><td>Set modification time on message files to message dates.</td></tr>
<tr valign="top"><td align="right"><b><a name="months" href="resources/months.html">MONTHS</a></b></td><td></td><td>Month names.</td></tr>
<tr valign="top"><td align="right"><b><a name="monthsabr" href="resources/monthsabr.html">MONTHSABR</a></b></td><td></td><td>Abbreviated month names.</td></tr>
<tr valign="top"><td align="right"><b><a name="msgbodyend" href="resources/msgbodyend.html">MSGBODYEND</a></b></td><td></td><td>Markup after the message body.</td></tr>
<tr valign="top"><td align="right"><b><a name="msgexcfilter" href="resources/msgexcfilter.html">MSGEXCFILTER</a></b></td><td></td><td>Perl expression(s) to selectively exclude messages.</td></tr>
<tr valign="top"><td align="right"><b><a name="msgfoot" href="resources/msgfoot.html">MSGFOOT</a></b></td><td></td><td>Markup at the foot of each message page.</td></tr>
<tr valign="top"><td align="right"><b><a name="msggmtdatefmt" href="resources/msggmtdatefmt.html">MSGGMTDATEFMT</a></b></td><td></td><td>GMT conversion specification for message dates.</td></tr>
<tr valign="top"><td align="right"><b><a name="msghead" href="resources/msghead.html">MSGHEAD</a></b></td><td></td><td>Markup at the head of each message page.</td></tr>
doc/resources/authorbegin.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/botlinks.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/daybegin.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/definederived.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/foluplitxt.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/headbodysep.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/icons.html view on Meta::CPAN
</p>
</dd>
</dl>
<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>
<P>The ICONS resource is used to specify the icons that represent the
different content-types of messages. This resource is used to
define the possible expanded values of the
<tt><a href="../rcvars.html#ICON">$ICON$</a></tt> resource variable.
</p>
<p>The ICON resource can only be defined via the resource file element.
The format of each line in the <CODE>ICONS</CODE> element is as
follows:
</p>
<pre>
<var>content-type</var>:<var>url</var>
</pre>
<p>The definition of each item is a follows:
<dl>
<dt><var>content-type</var></dt>
<dd><p>MIME content-type that an icon should be associated to.
Examples: <tt>text/plain</tt>, <tt>image/jpeg</tt>. An icon
can be associated to a base type by using a <tt>*</tt> as the
sub-type. Examples: <tt>text/*</tt>, <tt>image/*</tt>. The
default icon can be specified by using a content-type of
<tt>*/*</tt>.
</p>
</dd>
<dt><var>url</var></dt>
<dd><p>The URL of the icon. Example: <tt>http://host/icons/text.gif</tt>,
<tt>/icons/image.gif</tt>.
</p>
<p>The url can be prefixed with a
width and height specification to provide rendering hints to
doc/resources/icons.html view on Meta::CPAN
<pre class="code">
<b><LiTemplate></b>
$ICON$ <strong>$SUBJECT:40$</strong>
<em>$FROMNAME$</em><br>
<b></LiTemplate></b>
</pre>
<P>The <CODE>$ICON$</CODE> variable expands to the <CODE>IMG</CODE>
HTML element with the appropriate URL in the <CODE>SRC</CODE> attribute
to the icon. The <CODE>ALT</CODE> attribute of the <CODE>IMG</CODE>
element contains the content-type of the message, surrounded by
<CODE>[]</CODE>'s, for use with text based browsers. If the width
and height values have been defined for the given URL as described
earlier, they will map to the <tt>WIDTH</tt> and <tt>HEIGHT</tt> attributes.
</P>
<p>The <tt><a href="../rcvars.html#ICONURL">$ICONURL$</a></tt> resource
variable may be used if you want redefine the format of the
<CODE>IMG</CODE> element. For example:
</p>
doc/resources/litemplate.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/mimealtprefs.html view on Meta::CPAN
<dl>
<dt><strong>Envariable</strong></dt>
<dd><p>N/A
</p>
</dd>
<dt><strong>Element</strong></dt>
<dd><p>
<code><MIMEALTPREFS></code><br>
<var>content-type</var><br>
<var>content-type</var><br>
...<br>
<code></MIMEALTPREFS></code><br>
</p>
</dd>
<dt><strong>Command-line Option</strong></dt>
<dd><p>N/A
</p>
</dd>
doc/resources/mimeargs.html view on Meta::CPAN
<dl>
<dt><strong>Envariable</strong></dt>
<dd><p>N/A
</p>
</dd>
<dt><strong>Element</strong></dt>
<dd><p>
<code><MIMEARGS><br></code>
<var>content-type</var><code>:</code><var>argument-string</var><br>
<var>...</var><br>
<code></MIMEARGS><br></code>
</p>
</dd>
<dt><strong>Command-line Option</strong></dt>
<dd><p>N/A
</p>
</dd>
</dl>
<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>
<P>The MIMEARGS resource may be used to pass optional
arguments to MIME filters to control their behavior. Arguments may
be defined on a per content-type basis, or for a specific filter
itself. The MIMEARGS resource can only be set via the
<CODE>MIMEARGS</CODE> element.
The syntax for each line of the the <CODE>MIMEARGS</CODE>
element is as follows: </P>
<P><var>content-type</var><CODE>;</CODE><var>argument-string</var>
</P>
<P>Or,
</P>
<P><var>filter-name</var><CODE>;</CODE><var>argument-string</var>
</P>
<P>The format of argument strings is dependent on the filter that
processes <var>content-type</var> or by the specified filter,
<var>filter-name</var>. </P>
<P>If an argument string is defined for a filter explicitly and for a
content-type that the filter processes, the content-type string will
override the filter string. </P>
<!-- *************************************************************** -->
<hr>
<h2><a name="default">Default Setting</a></h2>
<PRE class="code">
<b><MIMEArgs></b>
m2h_external::filter; inline
doc/resources/mimeexcs.html view on Meta::CPAN
<dl>
<dt><strong>Envariable</strong></dt>
<dd><p>N/A
</p>
</dd>
<dt><strong>Element</strong></dt>
<dd><p>
<code><MIMEEXCS></code><br>
<var>content-type</var><br>
<var>content-type</var><br>
...<br>
<code></MIMEEXCS></code><br>
</p>
</dd>
<dt><strong>Command-line Option</strong></dt>
<dd><p>N/A
</p>
</dd>
</dl>
<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>
<p>MIMEEXCS defines the list of content-types to exclude from processing.
The exclusion occurs before the data is processed to any filters
registered via the <a href="mimefilters.html">MIMEFILTERS</a> resource.
</p>
<p>For example, if MIMEEXCS is set to the following:
</p>
<pre class="code">
<b><MIMEExcs></b>
image/jpg
image/gif
<b></MIMEExcs></b>
</pre>
<p>Then JPEG and GIF images will be excluded.
</p>
<p>Base types can be listed in order exclude all
content-types
with a give base. For example,
</p>
<pre class="code">
<b><MIMEExcs></b>
image
<b></MIMEExcs></b>
</pre>
<p>will exclude all images.
</p>
doc/resources/mimefilters.html view on Meta::CPAN
<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>
<P>The resource MIMEFILTERS is used to hook in user specifed filters
into MHonArc. The MIMEFILTERS resource can only be set via the
<CODE>MIMEFILTERS</CODE> element. The syntax for each line of the
the <CODE>MIMEFILTERS</CODE> element is as follows: </P>
<P><var>content-type</var><CODE>;</CODE><var>routine-name</var><CODE>;</CODE><var>file-of-routine</var> </P>
<P>The definition of each semi-colon-separated value is as follows:
</P>
<DL>
<DT><var>content-type</var>
<DD><P>The MIME content-type the filter processes. An explicit
content-type (base/subtype) or a base content-type (base/*)
can be specified.
</P>
<DT><var>routine-name</var>
<DD><P>The actual routine name of the filter. The name
should be fully qualified by the package it is defined in
(e.g. "<CODE>mypackage::filter</CODE>"). </P>
<DT><var>file-of-routine</var>
<DD><P>The name of the file that defines
doc/resources/mimefilters.html view on Meta::CPAN
<table cellspacing=1 border=0 cellpadding=4>
<tr valign=top>
<td><strong><code><a name="fields_hash_ref"
>$fields_hash_ref</a></code></strong></td>
<td><p>A reference to hash of message/part header
fields. Keys are field names in lowercase
and values are array references containing the
field values. For example, to obtain the
content-type, if defined, you would do:
</p>
<pre class="code">
$fields_hash_ref->{'content-type'}[0]</pre>
<p>Values for a fields are stored in arrays since
duplication of fields are possible. For example,
the <tt>Received:</tt> header field is typically repeated
multiple times. For fields that only occur once,
the array for the field will only contain one
item.
</p>
<p>See <a href="#xmhafields"><cite>Special Variables and Header
Fields</a> for more information about this parameter.
</p>
doc/resources/mimefilters.html view on Meta::CPAN
represents the character set encoding of the text entity.
</p>
<p>If your filter will take character encoding into account, you
should use this value vs what is specified in regular entity header
fields because <a href="textencode.html">TEXTENCODE</a> may be affect,
so the effective character encoding of the data may be different from
the original encoding specified in the message.
</p>
</dd>
<dt><b><tt>x-mha-content-type</tt></b></dt>
<dd><pre class="code">my $content_type = $fields_hash_ref->{'x-mha-content-type'}</pre>
<p>The media type of the entity extracted from content-type entity header.
</p>
</dd>
<dt><b><tt>x-mha-part-number</tt></b></dt>
<dd><pre class="code">
my $part_no = $fields_hash_ref->{'x-mha-part-number'}
my $full_part_no = readmail::gen_full_part_number($fields_hash_ref);</pre>
<p>The child number of the entity within a multipart entity. Numbering
starts with 1, and if data is not part of a multipart entity, this
key may not be defined.
doc/resources/mimefilters.html view on Meta::CPAN
is an example how the link is formatted:
</P>
<dl>
<dd><p><strong>Attachment:
<a href=""><tt>blueball.gif</tt></a></strong><br>
<em>Description:</em> Blue ball GIF icon</p>
</dd></dl>
<p>The description text is retrieved from the <tt>Content-Disposition</tt>
message header field, if defined. If not defined, a generic description
will be provided based on the specified content-type of the data.
</p>
<p>If the <tt>useicon</tt> filter argument has been specified for the
filter, the following format will be used:
</p>
<dl><dd><p><strong><a href="" ><img src="../monicon.png" align="left" border=0 alt="Attachment:"></a>
<a href="" ><tt>blueball.gif</tt></a></strong><br>
<em>Description:</em> Blue ball GIF icon</p>
</dd></dl>
doc/resources/mimefilters.html view on Meta::CPAN
</p>
<table cellspacing=1 border=0 cellpadding=4>
<tr valign=top>
<td><strong><tt>excludeexts=</tt></strong><var>ext1</var><tt>,</tt>...</td>
<td width="100%"><p>A comma separated list of message specified filename extensions
to exclude. I.e. If the filename extension matches an extension
in excludeexts, the content will not be written. The return markup
will contain the name of the attachment, but no link to the data.
This option is best used with application/octet-stream to exclude
unwanted data that is not tagged with the proper content-type.
</p>
</td>
</tr>
<tr valign=top>
<td><strong><tt>ext=<var>ext</var></tt></strong></td>
<td><p>Use <var>ext</var> as the filename extension.
The filter already has a large list of extensions for various
content-types. Use this argument if you process a
content-type not recognized by the filter.
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>forceattach</tt></strong></td>
<td><p>Force images to never be displayed inline, overriding any
Content-Disposition setting.
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>forceinline</tt></strong></td>
doc/resources/mimefilters.html view on Meta::CPAN
</tr>
<tr valign=top>
<td><strong><tt>inline</tt></strong></td>
<td><p>Inline image data by default if content-disposition not defined.
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>inlineexts=</tt></strong><var>ext1</var><tt>,</tt>...</td>
<td><p>A comma separated list of message specified filename
extensions to treat as possible inline data.
Applicable when content-type is not <tt>image/</tt><var>*</var> and
<b><tt>usename</tt></b> or <b><tt>usenameext</tt></b> is in effect.
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>type="<var>description</var>"</tt></strong></td>
<td><p>Use "<var>description</var>" as type description of the
data. The double quotes are required.
The filter already has a large list of descriptions for various
content-types. Use this argument if you process a
content-type not recognized by the filter.
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>subdir</tt></strong></td>
<td><p>Place derived file in a subdirectory of the archive.
The subdirectory will be called "<tt>msg<var>MSGNUM</var></tt>".
This option may be useful if <strong><tt>usename</tt></strong> is
specified to minimize security and name conflict problems.
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>target=</tt></strong><var>name</var></td>
<td><p>Set the TARGET attribute of anchor link to file
Default value is undefined (ie. no TARGET attribute will be
written).
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>useicon</tt></strong></td>
<td><p>Include a content-type icon with the hyperlink to
the derived file. The icon used is the value of the
<strong><tt>iconurl</tt></strong> option or the icon
defined by the <a href="icons.html">ICONS</a> resource.
</p></td>
</tr>
<tr valign=top>
<td><strong><tt>usename</tt></strong></td>
<td><p>Use (file)name attribute for determining name
of derived file.
</p>
doc/resources/mimefilters.html view on Meta::CPAN
Use this option with caution since it can lead to
security problems.
</p>
</td></tr></table>
</td>
</tr>
</table>
<p>All arguments should be separated by at least one space.</p>
<p>The following table shows the default list of content-types with the
filename extension used and a short
description that <strong><tt>m2h_external::filter</tt></strong>
recognizes:
</p>
<center>
<!--X-Ext-CType-Start-->
<table border=1 cellpadding=1>
<tr bgcolor="#C0C0C0">
<th align=left>Content-type</th><th align=center>Extension</th><th align=left>Description</th></tr>
doc/resources/mimefilters.html view on Meta::CPAN
<H3><a name="m2h_text_tsv">m2h_text_tsv::filter</a></h3>
<p>This filter converts text/tab-separated-values to HTML. The
tabular data will be converted into an HTML table.
</p>
<H3><a name="m2h_null">m2h_null::filter</a></h3>
<p>This filter can be used to exclude message content from archives.
You can register this filter to any content-type you do not want
to store in your archives. For example, the following resource setting
excludes all images:
</p>
<pre class="code">
<b><MIMEFilters></b>
image/*; m2h_null::filter</a>; mhnull.pl
<b></MIMEFilters></b>
</pre>
<p>The markup returned by this filter displays the one line description
of what was excluded. Examples:
</p>
<pre class="code">
<<attachment: HelloWorld.jpg>>
<<application/postscript>>
<<inline: image/jpg>>
</pre>
<p>If the disposition is available, it will be shown. If a filename
was specified, it will be shown. If there was no filename, the
content-type is shown.
</p>
<table class="note" width="100%">
<tr valign=top>
<td><strong>NOTE:</strong></td>
<td width="100%"><p>The sematics of using the
<a href="mimeexcs.html">MIMEEXCS</a> resource vs this filter are different.
When using this filter, MHonArc considers the data
successfully converted. But with <a href="mimeexcs.html">MIMEEXCS</a>,
MHonArc does not consider the data converted. This is relevant when
doc/resources/mimeincs.html view on Meta::CPAN
<dt><strong>Envariable</strong></dt>
<dd><p>
N/A
</p>
</dd>
<dt><strong>Element</strong></dt>
<dd><p>
<code><MIMEINCS></code><br>
<var>content-type</var><br>
<var>content-type</var><br>
...<br>
<code></MIMEINCS></code><br>
</p>
</dd>
<dt><strong>Command-line Option</strong></dt>
<dd><p>
N/A
</p>
</dd>
</dl>
<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>
<p>MIMEINCS defines the list of content-types (aka media-types) to allow.
If the MIMEINCS resource is not empty, only media-types listed will
be allowed. All other media-types will be excluded.
</p>
<p>For example, if MIMEINCS is set to the following:
</p>
<pre class="code">
<b><MIMEIncs></b>
text/plain
text/html
<b></MIMEIncs></b>
doc/resources/msgfoot.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/msghead.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/msgidlink.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
doc/resources/msgpgbegin.html view on Meta::CPAN
<tr valign=top>
<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
</tr>
<tr valign=top>
<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
<td>Current GMT date.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
<td>The content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
<td>URL to the content-type sensitive icon.</td>
</tr>
<tr valign=top>
<td align=center><a name="ICONURLPREFIX" href="../rcvars.html#ICONURLPREFIX"><strong><code>$ICONURLPREFIX$</code></strong></a></td>
<td>Value of ICONURLPREFIX resource.</td>
</tr>
<tr valign=top>
<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
<td>Filename of main index page.</td>
</tr>
<tr valign=top>
( run in 2.684 seconds using v1.01-cache-2.11-cpan-524268b4103 )