1Encode::MIME::EncWords(U3s)er Contributed Perl DocumentatEinocnode::MIME::EncWords(3)
2
3
4

NAME

6       Encode::MIME::EncWords -- MIME 'B' and 'Q' header encoding
7       (alternative)
8

SYNOPSIS

10           use Encode::MIME::EncWords;
11           use Encode qw/encode decode/;
12
13           # decode header:
14           $utf8   = decode('MIME-EncWords', $header);
15
16           # encode header with default charset, UTF-8:
17           $header = encode('MIME-EncWords', $utf8);
18
19           # encode header with another charset:
20           Encode::MIME::EncWords->config(Charset => 'GB2312');
21           $header = encode('MIME-EncWords', $utf8);
22

ABSTRACT

24       This module implements MIME header encoding described in RFC 2047.
25       There are three variant encoding names and one shorthand special to a
26       charset:
27
28         Encoding name              Result of encode()     Comment
29         -------------------------------------------------------------------
30         MIME-EncWords              (auto-detect B or Q)
31         MIME-EncWords-B            =?XXXX?B?...?=         Default is UTF-8.
32         MIME-EncWords-Q            =?XXXX?Q?...?=                ,,
33         MIME-EncWords-ISO_2022_JP  =?ISO-2022-JP?B?...?=
34
35       All encodings generate the same result by decode().
36

DESCRIPTION

38       This module is intended to be an alternative of "MIME-*" encodings
39       provided by Encode::MIME::Header core module.  To find out how to use
40       this module in detail, see Encode.
41
42   Module specific feature
43       config(KEY => VALUE, ...);
44           Class method.  Set options by KEY => VALUE pairs.  Following
45           options are available.
46
47           Charset
48               [encode] Name of character set by which data elements will be
49               converted.  Default is "UTF-8".  On "MIME-EncWords-ISO_2022_JP"
50               it is fixed to "ISO-2022-JP".
51
52           Detect7bit
53               [decode/encode] Try to detect 7-bit charset on unencoded
54               portions.  Default is "YES".
55
56           Field
57               [encode] Name of the header field which will be considered on
58               the first line of encoded result in its length.  Default is
59               "undef".
60
61           Mapping
62               [decode/encode] Specify mappings actually used for charset
63               names.  Default is "EXTENDED".
64
65           MaxLineLen
66               [encode] Maximum line length excluding newline.  Default is 76.
67
68           Minimal
69               [encode] Whether to do minimal encoding or not.  Default is
70               "YES".
71
72           For more details about options see MIME::EncWords.
73

CAVEAT

75       ·   The encoding modules for MIME header encoding are not the magic
76           porridge pot to cook complex header fields properly.
77
78           To decode address header fields (From:, To:, ...), at first parse
79           mailbox-list; then decode each element by encoding module.  To
80           encode them, at first encode each element by encoding module; then
81           construct mailbox-list of encoded elements.  To construct or parse
82           mailbox-list, some modules such as Mail::Address may be used.
83
84       ·   Lines are delimited with LF ("\n").  RFC5322 states that lines in
85           Internet messages are delimited with CRLF ("\r\n").
86

BUGS

88       Please report bugs or buggy behaviors to developer.
89
90       CPAN Request Tracker:
91       <http://rt.cpan.org/Public/Dist/Display.html?Name=MIME-EncWords>.
92

VERSION

94       Consult $VERSION variable.
95
96       This is experimental release.  Features might be changed in the near
97       future.
98
99       Development versions of this package may be found at
100       <http://hatuka.nezumi.nu/repos/MIME-EncWords/>.
101

SEE ALSO

103       Encode, Encode::MIME::Header, MIME::EncWords.
104
105       RFC 2047 MIME (Multipurpose Internet Mail Extensions) Part Three:
106       Message Header Extensions for Non-ASCII Text.
107

AUTHOR

109       Hatuka*nezumi - IKEDA Soji <hatuka(at)nezumi.nu>
110

112       Copyright (C) 2011 Hatuka*nezumi - IKEDA Soji.
113
114       This program is free software; you can redistribute it and/or modify it
115       under the same terms as Perl itself.
116
117
118
119perl v5.32.0                      2020-07-28         Encode::MIME::EncWords(3)
Impressum