| Current Path : /usr/local/lib/perl5/5.8.9/man/man3/ |
FreeBSD hs32.drive.ne.jp 9.1-RELEASE FreeBSD 9.1-RELEASE #1: Wed Jan 14 12:18:08 JST 2015 root@hs32.drive.ne.jp:/sys/amd64/compile/hs32 amd64 |
| Current File : //usr/local/lib/perl5/5.8.9/man/man3/MIME::EcoEncode.3 |
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MIME::EcoEncode 3"
.TH MIME::EcoEncode 3 "2013-11-13" "perl v5.8.9" "User Contributed Perl Documentation"
.SH "NAME"
MIME::EcoEncode \- MIME Encoding (Economical)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 15
\& use MIME::EcoEncode;
\& $encoded = mime_eco($str, 'UTF-8'); # encode utf8 string
\& $encoded = mime_eco($str, 'UTF-8?B'); # ditto ("B" encoding)
\& $encoded = mime_eco($str, 'UTF-8?Q'); # ditto ("Q" encoding)
\& $encoded = mime_eco($str, 'UTF-8*XX'); # XX is RFC2231's language
\& $encoded = mime_eco($str, 'UTF-8*XX?B'); # ditto ("B" encoding)
\& $encoded = mime_eco($str, 'UTF-8*XX?Q'); # ditto ("Q" encoding)
\& $encoded = mime_eco($str, 'GB2312'); # encode euc-cn string
\& $encoded = mime_eco($str, 'EUC-KR'); # encode euc-kr string
\& $encoded = mime_eco($str, 'Big5'); # encode big5 string
\& $encoded = mime_eco($str, 'Shift_JIS'); # encode cp932 string
\& $encoded = mime_eco($str, 'ISO-2022-JP'); # encode 7bit-jis string
\& $encoded = mime_eco($str, $sbcs); # $sbcs :
\& # single-byte charset
\& # (e.g. 'ISO-8859-1')
.Ve
.PP
.Vb 2
\& $decoded = mime_deco($encoded); # decode encoded string
\& # (for single charset)
.Ve
.PP
.Vb 2
\& ($decoded, $charset, $language) # return array
\& = mime_deco($encoded); # (for single charset)
.Ve
.PP
.Vb 3
\& use Encode;
\& $decoded = mime_deco($encoded, \e&cb); # cb is callback subroutine
\& # (for multiple charsets)
.Ve
.PP
.Vb 5
\& # Example of callback subroutine
\& sub cb {
\& my ($encoded_word, $charset, $language, $decoded_word) = @_;
\& encode_utf8(decode($charset, $decoded_word));
\& }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements \s-1RFC\s0 2047 Mime Header Encoding.
.Sh "Options"
.IX Subsection "Options"
.Vb 15
\& $encoded = mime_eco($str, $charset, $lf, $bpl, $mode, $lss);
\& # $charset : 'UTF-8' / 'UTF-8?Q' / 'UTF-8*XX' /
\& # 'GB2312' / 'EUC-KR' / 'Big5' /
\& # 'Shift_JIS' / 'ISO-2022-JP' / ...
\& # (default: 'UTF-8')
\& # Note: "B" encoding is all defaults.
\& # The others are all encoded as
\& # single-byte string.
\& # $lf : line feed (default: "\en")
\& # $bpl : bytes per line (default: 76)
\& # $mode : 0 : unstructured header (e.g. Subject)
\& # 1 : structured header (e.g. To, Cc, From)
\& # 2 : auto (Subject or Comments ? 0 : 1)
\& # (default: 2)
\& # $lss : length of security space (default: 25)
.Ve
.Sh "Examples"
.IX Subsection "Examples"
Ex1 \- normal (structured header)
.PP
.Vb 3
\& use MIME::EcoEncode;
\& my $str = "From: Sakura <sakura\e@example.jp> (\exe6\exa1\ex9c)\en";
\& print mime_eco($str);
.Ve
.PP
Ex1's output:
.PP
.Vb 1
\& From: Sakura <sakura@example.jp> (=?UTF-8?B?5qGc?=)
.Ve
.PP
Ex2 \- \*(L"Q\*(R" encoding + \s-1RFC2231\s0's language
.PP
.Vb 3
\& use MIME::EcoEncode;
\& my $str = "From: Sakura <sakura\e@example.jp> (\exe6\exa1\ex9c)\en";
\& print mime_eco($str, 'UTF-8*ja-JP?Q');
.Ve
.PP
Ex2's output:
.PP
.Vb 1
\& From: Sakura <sakura@example.jp> (=?UTF-8*ja-JP?Q?=E6=A1=9C?=)
.Ve
.PP
Ex3 \- continuous spaces
.PP
.Vb 3
\& use MIME::EcoEncode;
\& my $str = "From: Sakura <sakura\e@example.jp> (\exe6\exa1\ex9c)\en";
\& print mime_eco($str);
.Ve
.PP
Ex3's output:
.PP
.Vb 1
\& From: Sakura <sakura@example.jp> (=?UTF-8?B?5qGc?=)
.Ve
.PP
Ex4 \- unstructured header (1)
.PP
.Vb 3
\& use MIME::EcoEncode;
\& my $str = "Subject: Sakura (\exe6\exa1\ex9c)\en";
\& print mime_eco($str);
.Ve
.PP
Ex4's output:
.PP
.Vb 1
\& Subject: Sakura =?UTF-8?B?KOahnCk=?=
.Ve
.PP
Ex5 \- unstructured header (2)
.PP
.Vb 3
\& use MIME::EcoEncode;
\& my $str = "Subject: \exe6\exa1\ex9c Sakura\en";
\& print mime_eco($str);
.Ve
.PP
Ex5's output:
.PP
.Vb 1
\& Subject: =?UTF-8?B?5qGc?= Sakura
.Ve
.PP
Ex6 \- 7bit\-jis string
.PP
.Vb 4
\& use Encode;
\& use MIME::EcoEncode;
\& my $str = "Subject: \exe6\exa1\ex9c Sakura\en";
\& print mime_eco(encode('7bit-jis', decode_utf8($str)), 'ISO-2022-JP');
.Ve
.PP
Ex6's output:
.PP
.Vb 1
\& Subject: =?ISO-2022-JP?B?GyRCOnkbKEI=?= Sakura
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MIME::EcoEncode::Param, MIME::EcoEncode::Fold
.PP
For more information, please visit \fIhttp://www.nips.ac.jp/~murata/mimeeco/\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\s-1MURATA\s0 Yasuhisa <murata@nips.ac.jp>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2011\-2013 \s-1MURATA\s0 Yasuhisa
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.