<HTML> <HEAD> <TITLE>MIME::Words</TITLE> </HEAD> <BODY bgcolor="#FFFFFF" link="#CC3366" vlink="#993366" alink="#FF6666"> <FONT FACE="sans-serif" SIZE=-1><A HREF="http://www.zeegee.com" TARGET="_top"><IMG SRC="icons/zeegee.gif" ALT="ZeeGee Software" ALIGN="RIGHT" BORDER="0"></A><A NAME="__TOP__"><H1>MIME::Words</H1> </A> <P><B>This module is <FONT COLOR="#990000">BETA</FONT> code, which means that the interfaces are fairly stable BUT it has not been out in the community long enough to guarantee much testing. Use with caution! Please report any errors back to <A HREF="mailto:eryq@zeegee.com">eryq@zeegee.com</A> as soon as you can.</B><UL> <LI> <A HREF="#NAME">NAME</A> <LI> <A HREF="#SYNOPSIS">SYNOPSIS</A> <LI> <A HREF="#DESCRIPTION">DESCRIPTION</A> <LI> <A HREF="#PUBLIC_INTERFACE">PUBLIC INTERFACE</A> <LI> <A HREF="#NOTES">NOTES</A> <LI> <A HREF="#AUTHOR">AUTHOR</A> <LI> <A HREF="#VERSION">VERSION</A> </UL> </A> <P><HR> <A NAME="NAME"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> NAME</H2></A> <P>MIME::Words - deal with RFC-1522 encoded words <P><HR> <A NAME="SYNOPSIS"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> SYNOPSIS</H2></A> <P>Before reading further, you should see <A HREF="../MIME/Tools.pm.html">MIME::Tools</A> to make sure that you understand where this module fits into the grand scheme of things. Go on, do it now. I'll wait. <P>Ready? Ok... <FONT SIZE=3 FACE="courier"><PRE> use MIME::Words qw(:all); ### Decode the string into another string, forgetting the charsets: $decoded = decode_mimewords( 'To: =?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= <keld@dkuug.dk>', ); ### Split string into array of decoded [DATA,CHARSET] pairs: @decoded = decode_mimewords( 'To: =?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= <keld@dkuug.dk>', ); ### Encode a single unsafe word: $encoded = encode_mimeword("\xABFran\xE7ois\xBB"); ### Encode a string, trying to find the unsafe words inside it: $encoded = encode_mimewords("Me and \xABFran\xE7ois\xBB in town"); </PRE></FONT> <P><HR> <A NAME="DESCRIPTION"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> DESCRIPTION</H2></A> <P>Fellow Americans, you probably won't know what the hell this module is for. Europeans, Russians, et al, you probably do. <CODE>:-)</CODE>. <P>For example, here's a valid MIME header you might get: <FONT SIZE=3 FACE="courier"><PRE> From: =?US-ASCII?Q?Keith_Moore?= <moore@cs.utk.edu> To: =?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= <keld@dkuug.dk> CC: =?ISO-8859-1?Q?Andr=E9_?= Pirard <PIRARD@vm1.ulg.ac.be> Subject: =?ISO-8859-1?B?SWYgeW91IGNhbiByZWFkIHRoaXMgeW8=?= =?ISO-8859-2?B?dSB1bmRlcnN0YW5kIHRoZSBleGFtcGxlLg==?= =?US-ASCII?Q?.._cool!?= </PRE></FONT> <P>The fields basically decode to (sorry, I can only approximate the Latin characters with 7 bit sequences /o and 'e): <FONT SIZE=3 FACE="courier"><PRE> From: Keith Moore <moore@cs.utk.edu> To: Keld J/orn Simonsen <keld@dkuug.dk> CC: Andr'e Pirard <PIRARD@vm1.ulg.ac.be> Subject: If you can read this you understand the example... cool! </PRE></FONT> <P><HR> <A NAME="PUBLIC_INTERFACE"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> PUBLIC INTERFACE</H2></A> <DL> <P><DT><B><A NAME="item:decode_mimewords">decode_mimewords ENCODED, [OPTS...]</A></B></DT> <DD> <I>Function.</I> Go through the string looking for RFC-1522-style "Q" (quoted-printable, sort of) or "B" (base64) encoding, and decode them. <P><B>In an array context,</B> splits the ENCODED string into a list of decoded <CODE>[DATA, CHARSET]</CODE> pairs, and returns that list. Unencoded data are returned in a 1-element array <CODE>[DATA]</CODE>, giving an effective CHARSET of <CODE>undef</CODE>. <FONT SIZE=3 FACE="courier"><PRE> $enc = '=?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= <keld@dkuug.dk>'; foreach (decode_mimewords($enc)) { print "", ($_[1] || 'US-ASCII'), ": ", $_[0], "\n"; } </PRE></FONT> <P><B>In a scalar context,</B> joins the "data" elements of the above list together, and returns that. <I>Warning: this is information-lossy,</I> and probably <I>not</I> what you want, but if you know that all charsets in the ENCODED string are identical, it might be useful to you. (Before you use this, please see <A HREF="../MIME/WordDecoder.pm.html#item:unmime">unmime</A>, which is probably what you want.) <P>In the event of a syntax error, $@ will be set to a description of the error, but parsing will continue as best as possible (so as to get <I>something</I> back when decoding headers). $@ will be false if no error was detected. <P>Any arguments past the ENCODED string are taken to define a hash of options: <DL> <P><DT><B><A NAME="item:Field">Field</A></B></DT> <DD> Name of the mail field this string came from. <I>Currently ignored.</I> </DL> <P><DT><B><A NAME="item:encode_mimeword">encode_mimeword RAW, [ENCODING], [CHARSET]</A></B></DT> <DD> <I>Function.</I> Encode a single RAW "word" that has unsafe characters. The "word" will be encoded in its entirety. <FONT SIZE=3 FACE="courier"><PRE> ### Encode "<<Franc,ois>>": $encoded = encode_mimeword("\xABFran\xE7ois\xBB"); </PRE></FONT> <P>You may specify the ENCODING (<CODE>"Q"</CODE> or <CODE>"B"</CODE>), which defaults to <CODE>"Q"</CODE>. You may specify the CHARSET, which defaults to <CODE>iso-8859-1</CODE>. <P><DT><B><A NAME="item:encode_mimewords">encode_mimewords RAW, [OPTS]</A></B></DT> <DD> <I>Function.</I> Given a RAW string, try to find and encode all "unsafe" sequences of characters: <FONT SIZE=3 FACE="courier"><PRE> ### Encode a string with some unsafe "words": $encoded = encode_mimewords("Me and \xABFran\xE7ois\xBB"); </PRE></FONT> <P>Returns the encoded string. Any arguments past the RAW string are taken to define a hash of options: <DL> <P><DT><B><A NAME="item:Charset">Charset</A></B></DT> <DD> Encode all unsafe stuff with this charset. Default is 'ISO-8859-1', a.k.a. "Latin-1". <P><DT><B><A NAME="item:Encoding">Encoding</A></B></DT> <DD> The encoding to use, <CODE>"q"</CODE> or <CODE>"b"</CODE>. The default is <CODE>"q"</CODE>. <P><DT><B><A NAME="item:Field">Field</A></B></DT> <DD> Name of the mail field this string will be used in. <I>Currently ignored.</I> </DL> <P><B>Warning:</B> this is a quick-and-dirty solution, intended for character sets which overlap ASCII. <B>It does not comply with the RFC-1522 rules regarding the use of encoded words in message headers</B>. You may want to roll your own variant, using <CODE>encoded_mimeword()</CODE>, for your application. <I>Thanks to Jan Kasprzak for reminding me about this problem.</I> </DL> <P><HR> <A NAME="NOTES"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> NOTES</H2></A> <P>Exports its principle functions by default, in keeping with MIME::Base64 and MIME::QuotedPrint. <P><HR> <A NAME="AUTHOR"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> AUTHOR</H2></A> <P>Eryq (<I><FILE><A HREF="mailto:eryq@zeegee.com">eryq@zeegee.com</A></FILE></I>), ZeeGee Software Inc (<I><FILE><A HREF="http://www.zeegee.com">http://www.zeegee.com</A></FILE></I>). <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>Thanks also to... <FONT SIZE=3 FACE="courier"><PRE> Kent Boortz For providing the idea, and the baseline RFC-1522-decoding code! KJJ at PrimeNet For requesting that this be split into its own module. Stephane Barizien For reporting a nasty bug. </PRE></FONT> <P><HR> <A NAME="VERSION"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> VERSION</H2></A> <P>$Revision: 1.1 $ $Date: 2004/04/09 17:04:45 $ <P><HR> <ADDRESS><FONT SIZE=-1> Generated Wed Jan 17 01:58:46 2001 by cvu_pod2html </FONT></ADDRESS> </FONT></BODY> </HTML>