Gisle Aas > MIME-Base64-Perl-1.00 > MIME::QuotedPrint::Perl

Download:
MIME-Base64-Perl-1.00.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.00   Source  

NAME ^

MIME::QuotedPrint::Perl - Encoding and decoding of quoted-printable strings

SYNOPSIS ^

 use MIME::QuotedPrint::Perl;

 $encoded = encode_qp($decoded);
 $decoded = decode_qp($encoded);

DESCRIPTION ^

This module provide the same interface as MIME::QuotedPrint, but these functions are implemented in pure perl.

This module provides functions to encode and decode strings into and from the quoted-printable encoding specified in RFC 2045 - MIME (Multipurpose Internet Mail Extensions). The quoted-printable encoding is intended to represent data that largely consists of bytes that correspond to printable characters in the ASCII character set. Each non-printable character (as defined by English Americans) is represented by a triplet consisting of the character "=" followed by two hexadecimal digits.

The following functions are provided:

encode_qp($str)
encode_qp($str, $eol)

This function returns an encoded version of the string given as argument.

The second argument is the line-ending sequence to use. It is optional and defaults to "\n". Every occurrence of "\n" is replaced with this string, and it is also used for additional "soft line breaks" to ensure that no line is longer than 76 characters. You might want to pass it as "\015\012" to produce data suitable for external consumption. The string "\r\n" produces the same result on many platforms, but not all.

An $eol of "" (the empty string) is special. In this case, no "soft line breaks" are introduced and any literal "\n" in the original data is encoded as well.

decode_qp($str);

This function returns the plain text version of the string given as argument. The lines of the result are "\n" terminated, even if the $str argument contains "\r\n" terminated lines.

COPYRIGHT ^

Copyright 1995-1997,2002-2004 Gisle Aas.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

MIME::QuotedPrint, MIME::Base64::Perl

syntax highlighting: