.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "POD2::JA::Encode::MIME::EncWords 3pm"
.TH POD2::JA::Encode::MIME::EncWords 3pm 2024-02-14 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Encode::MIME::EncWords~[ja] \- MIME の「B」・「Q」ヘッダエンコーディング (代替案)
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Encode::MIME::EncWords;
\&    use Encode qw/encode decode/;
\&    
\&    # ヘッダデコードする。
\&    $utf8   = decode(\*(AqMIME\-EncWords\*(Aq, $header);
\&    
\&    # 初期のキャラクタセット (UTF\-8) でヘッダエンコードする。
\&    $header = encode(\*(AqMIME\-EncWords\*(Aq, $utf8);
\&    
\&    # ほかのキャラクタセットでヘッダエンコードする。
\&    Encode::MIME::EncWords\->config(Charset => \*(AqGB2312\*(Aq);
\&    $header = encode(\*(AqMIME\-EncWords\*(Aq, $utf8);
.Ve
.SH ABSTRACT
.IX Header "ABSTRACT"
このモジュールは、RFC 2047 に述べる
MIME のヘッダエンコーディングを実装している。
エンコーディングの名前には、みっつの変種と、
キャラクタセットに特化したひとつの簡易版がある。
.PP
.Vb 6
\&  エンコーディング名         encode() の結果        備考
\&  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&  MIME\-EncWords              (B と Q を自動判別)
\&  MIME\-EncWords\-B            =?XXXX?B?...?=         初期値は UTF\-8。
\&  MIME\-EncWords\-Q            =?XXXX?Q?...?=                ,,
\&  MIME\-EncWords\-ISO_2022_JP  =?ISO\-2022\-JP?B?...?=
.Ve
.PP
\&\fBdecode()\fR の結果は、どのエンコーディングでも同じになる。
.SH DESCRIPTION
.IX Header "DESCRIPTION"
このモジュールは、Encode::MIME::Header コアモジュールが提供する
\&\f(CW\*(C`MIME\-*\*(C'\fR エンコーディングの代替となることを意図している。
このモジュールの使いかたをよく知るためには、Encode を参照してほしい。
.SS モジュール独自の機能
.IX Subsection "モジュール独自の機能"
.IP "config(KEY => VALUE, ...);" 4
.IX Item "config(KEY => VALUE, ...);"
\&\fIクラスメソッド。\fR
KEY => VALUE の対でオプションを設定する。
次のオプションが使える。
.RS 4
.IP Charset 4
.IX Item "Charset"
[encode] データ要素を変換するのに使うキャラクタセット。
初期値は \f(CW"UTF\-8"\fR。
\&\f(CW\*(C`MIME\-EncWords\-ISO_2022_JP\*(C'\fR では \f(CW"ISO\-2022\-JP"\fR に固定。
.IP Detect7bit 4
.IX Item "Detect7bit"
[decode/encode] エンコードされていない部分の
7 ビットキャラクタセットを判別しようとする。
初期値は \f(CW"YES"\fR。
.IP Field 4
.IX Item "Field"
[encode] ヘッダフィールドの名前。エンコードされた結果の最初の行で、
これの長さが考慮される。
初期値は \f(CW\*(C`undef\*(C'\fR。
.IP Mapping 4
.IX Item "Mapping"
[decode/encode] キャラクタセットの名前に対して実際に使うマッピングを指定する。
初期値は \f(CW"EXTENDED"\fR。
.IP MaxLineLen 4
.IX Item "MaxLineLen"
[encode] 行の最大長 (改行を除く)。
初期値は \f(CW76\fR。
.IP Minimal 4
.IX Item "Minimal"
[encode] エンコーディングを最小限にするか否か。
初期値は \f(CW"YES"\fR。
.RE
.RS 4
.Sp
オプションの詳細については MIME::EncWords~[ja] を参照。
.RE
.SH CAVEAT
.IX Header "CAVEAT"
.IP \(bu 4
MIME ヘッダエンコーディング用のエンコーディングモジュールは、
こみいったヘッダフィールドを簡単に作り出したり、
そこから望みの要素を取り出したりできる打ち出の小槌ではない。
.Sp
アドレスヘッダフィールド (To:、From: など) をデコードするには、
まず mailbox-list を分解する。
そして、個々の要素をエンコーディングモジュールでデコードする。
これをエンコードするには、
今度は個々の要素をエンコーディングモジュールでエンコードする。
そして、エンコードした要素から mailbox-list を組み立てる。
mailbox-list の組み立てや分解には、Mail::Address
のようなモジュールが使えるだろう。
.IP \(bu 4
行を LF (\f(CW"\en"\fR) で区切る。
RFC5322 は、インターネットのメッセージでは行を CRLF (\f(CW"\er\en"\fR)
で区切るとしている。
.SH BUGS
.IX Header "BUGS"
バグやバグのような動作は開発者に知らせてください。
.PP
CPAN Request Tracker:
<http://rt.cpan.org/Public/Dist/Display.html?Name=MIME\-EncWords>.
.SH VERSION
.IX Header "VERSION"
\&\f(CW$VERSION\fR 変数を参照してほしい。
.PP
\&\fBこれは実験的なリリースである\fR。仕様は近い将来、変わるかもしれない。
.PP
このパッケージの開発版が次の場所にある。
<http://hatuka.nezumi.nu/repos/MIME\-EncWords/>。
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Encode, Encode::MIME::Header, MIME::EncWords~[ja].
.PP
RFC 2047 \fIMIME (Multipurpose Internet Mail Extensions) Part Three:
Message Header Extensions for Non-ASCII Text\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Hatuka*nezumi \- IKEDA Soji <hatuka(at)nezumi.nu>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2011 Hatuka*nezumi \- IKEDA Soji.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.