<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<!-- Generated by pod2coolhtml 1.101
-- Using Pod::CoolHTML 1.104 , (C) 1997 by Eryq (eryq@enteract.com).
--
-- DO NOT EDIT THIS HTML FILE! All your changes will be lost.
-- Edit the POD or Perl file that was used to create it.
-->
<HTML>
<HEAD>
<TITLE>MIME::ToolUtils</TITLE>
</HEAD>
<BODY LINK=#C00000 ALINK=#FF2020 VLINK=#900000>
<A NAME="__top"> </A><CENTER><TABLE BORDER=2 CELLPADDING=2 WIDTH=100%>
<TR>
<TD WIDTH=25% ALIGN=CENTER><B><FONT SIZE=+1>
<A HREF="Tools.pm.html">MIME::Tools</A></FONT></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Body.pm.html">MIME::Body</A></SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Decoder.pm.html">MIME::Decoder</A></SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Entity.pm.html">MIME::Entity</A></SMALL></B></TD>
<TR>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Head.pm.html">MIME::Head</A></SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="IO.pm.html">MIME::IO</A></SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Latin1.pm.html">MIME::Latin1</A></SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Parser.pm.html">MIME::Parser</A></SMALL></B></TD>
<TR>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="ParserBase.pm.html">MIME::ParserBase</A></SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
MIME::ToolUtils</SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Tools.pm.html">MIME::Tools</A></SMALL></B></TD>
<TD WIDTH=25% ALIGN=CENTER><B><SMALL>
<A HREF="Words.pm.html">MIME::Words</A></SMALL></B></TD>
</TABLE></CENTER>
<P><TABLE WIDTH="100%">
<TR VALIGN="TOP"><TD ALIGN="LEFT"><CENTER>
<H1><FONT SIZE=7 COLOR=#600020><B>MIME::<BR>ToolUtils</B></FONT></H1><IMG SRC="mime-sm.gif" ALT="MIME!"></CENTER>
<TD>
<UL>
<LI><A HREF="#name">NAME</A>
</LI><LI><A HREF="#description">DESCRIPTION</A>
</LI><LI><A HREF="#public_interface">PUBLIC INTERFACE</A>
</LI><LI><A HREF="#configuration_variables">CONFIGURATION VARIABLES</A>
</LI><LI><A HREF="#author">AUTHOR</A>
</LI><LI><A HREF="#version">VERSION</A>
</LI></UL>
</TABLE>
<P><HR>
<A NAME="name">
<H1><FONT COLOR=#600020>
<A HREF="#__top"><IMG SRC="h1bullet.gif" ALT="" BORDER="0"></A>
NAME</FONT></H1>
</A>
<P>
MIME::ToolUtils - MIME-tools kit configuration and utilities
<P><HR>
<A NAME="description">
<H1><FONT COLOR=#600020>
<A HREF="#__top"><IMG SRC="h1bullet.gif" ALT="" BORDER="0"></A>
DESCRIPTION</FONT></H1>
</A>
<P>
A catch-all place for miscellaneous global information related to
the configuration of the MIME-tools kit.
<P>
Since most of the MIME-tools modules "use" it by name, this module
is really not subclassable.
<P><HR>
<A NAME="public_interface">
<H1><FONT COLOR=#600020>
<A HREF="#__top"><IMG SRC="h1bullet.gif" ALT="" BORDER="0"></A>
PUBLIC INTERFACE</FONT></H1>
</A>
<DL>
<P><DT><B><A NAME="config">config [VARIABLE, [VALUE]]</A></B><DD>
<I>Class method.</I>
Set/get a configuration variable:
<P>
<PRE> # Get current debugging flag:
$current = config MIME::ToolUtils 'DEBUGGING';</PRE>
<P>
<PRE> # Invert it:
config MIME::ToolUtils DEBUGGING => !$current;</PRE>
<P>
The complete list of configuration variables is listed below. They are
all-uppercase, possibly with underscores. To get a list of all valid config
variables in your program, and output their current values, you can say:
<P>
<PRE> foreach $var (sort (config MIME::ToolUtils)) {
print "MIME config $var = ", (config MIME::ToolUtils $var), "\n";
}</PRE>
<P>
Note that some of these variables may have nice printed representations,
while others may not.
<P>
<I>Rationale:</I> I wanted access to the configuration to be done via
some kind of controllable public interface, in case "setting a config
variable" involved making a subroutine call. This approach is an attempt
to do so while preventing an explosion of lots of little methods, many
of which will do nothing more than set an entry in the internal %CONFIG hash.
I suppose a tied hash would have been slicker.
</DL>
<P><HR>
<A NAME="configuration_variables">
<H1><FONT COLOR=#600020>
<A HREF="#__top"><IMG SRC="h1bullet.gif" ALT="" BORDER="0"></A>
CONFIGURATION VARIABLES</FONT></H1>
</A>
<P>
You may set/get all of these via the <CODE>config</CODE> method.
<DL>
<P><DT><B><A NAME="debugging">DEBUGGING</A></B><DD>
Value should be a boolean: true to turn debugging on, false to turn it off.
<P><DT><B><A NAME="emulate_tmpfile">EMULATE_TMPFILE</A></B><DD>
<I>Obsolete.</I> Prior to our 4.x release, this determined how to patch a
Perl 5.004 bug in FileHandle::new_tmpfile, and get a FileHandle object
which really <I>will</I> be destroyed when it goes out of scope. The
bug has been corrected in 5.004, so this option (and much of the bulky code
which supported it) was removed; pre-5.004 installations will use
the "opendup" emulation, which has been hardcoded.
<P><DT><B><A NAME="emulate_version">EMULATE_VERSION</A></B><DD>
Emulate the behavior of a previous version of the MIME-tools kit (a.k.a
the MIME-parser kit in its version 1.x incarnations). Since 1.x emulation
was turned off in 4.x, this doesn't really do anything currently.
<P><DT><B><A NAME="quiet">QUIET</A></B><DD>
Most of the warnings from this toolkit may be silenced if you set
QUIET true. The default is false.
<P><DT><B><A NAME="version">VERSION</A></B><DD>
<I>Read-only.</I> The version of the <I>toolkit.</I>
<P>
<PRE> config MIME::ToolUtils VERSION => 1.0;</PRE>
<P>
Please notice that as of 3.x, this <I>happens</I> to be the same as the
$MIME::ToolUtils::VERSION: however, this was not always the case, and
someday may not be the case again.
</DL>
<P><HR>
<A NAME="author">
<H1><FONT COLOR=#600020>
<A HREF="#__top"><IMG SRC="h1bullet.gif" ALT="" BORDER="0"></A>
AUTHOR</FONT></H1>
</A>
<P>
Copyright (c) 1996, 1997 by Eryq / eryq@zeegee.com
<P>
All rights reserved. This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
<P><HR>
<A NAME="version">
<H1><FONT COLOR=#600020>
<A HREF="#__top"><IMG SRC="h1bullet.gif" ALT="" BORDER="0"></A>
VERSION</FONT></H1>
</A>
<P>
$Revision: 4.102 $ $Date: 1997/12/14 03:07:10 $
<P>
<I>Note: this file is used to set the version of the entire MIME-tools
distribution.</I>
<P><HR>
<SMALL>
Last updated: Sat Jan 17 23:02:00 1998 <BR>
Generated by pod2coolhtml 1.101. Want a copy? Just email
<A HREF="mailto:eryq@enteract.com">eryq@enteract.com</A>.
(Yes, it's free.)
</SMALL></BODY>
</HTML>