.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.45)
.\"
.\" 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 "Encode::IMAPUTF7 3"
.TH Encode::IMAPUTF7 3 2025-05-26 "perl v5.40.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::IMAPUTF7 \- modification of UTF\-7 encoding for IMAP
.SH VERSION
.IX Header "VERSION"
version 1.07
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Encode qw/encode decode/;
\&    use Encode::IMAPUTF7;
\&
\&    print encode(\*(AqIMAP\-UTF\-7\*(Aq, \*(AqRépertoire\*(Aq);
\&    print decode(\*(AqIMAP\-UTF\-7\*(Aq, \*(AqR&AOk\-pertoire\*(Aq);
.Ve
.SH "PERL VERSION"
.IX Header "PERL VERSION"
This library should run on perls released even a long time ago.  It should
work on any version of perl released in the last five years.
.PP
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased.  The version may be increased
for any reason, and there is no promise that patches will be accepted to
lower the minimum required perl.
.SH ABSTRACT
.IX Header "ABSTRACT"
IMAP mailbox names are encoded in a modified UTF\-7 when names contains
international characters outside of the printable ASCII range. The modified
UTF\-7 encoding is defined in RFC2060 (section 5.1.3).
.SS "RFC2060 \- section 5.1.3 \- Mailbox International Naming Convention"
.IX Subsection "RFC2060 - section 5.1.3 - Mailbox International Naming Convention"
By convention, international mailbox names are specified using a modified
version of the UTF\-7 encoding described in [UTF\-7].  The purpose of these
modifications is to correct the following problems with UTF\-7:
.IP 1. 4
UTF\-7 uses the "+" character for shifting; this conflicts with the common use of "+" in mailbox names, in particular USENET newsgroup names.
.IP 2. 4
UTF\-7's encoding is BASE64 which uses the "/" character; this conflicts with the use of "/" as a popular hierarchy delimiter.
.IP 3. 4
UTF\-7 prohibits the unencoded usage of "\e"; this conflicts with the use of "\e" as a popular hierarchy delimiter.
.IP 4. 4
UTF\-7 prohibits the unencoded usage of "~"; this conflicts with the use of "~" in some servers as a home directory indicator.
.IP 5. 4
UTF\-7 permits multiple alternate forms to represent the same string; in particular, printable US-ASCII chararacters can be represented in encoded form.
.PP
In modified UTF\-7, printable US-ASCII characters except for "&" represent
themselves; that is, characters with octet values 0x20\-0x25 and 0x27\-0x7e.  The
character "&" (0x26) is represented by the two-octet sequence "&\-".
.PP
All other characters (octet values 0x00\-0x1f, 0x7f\-0xff, and all Unicode 16\-bit
octets) are represented in modified BASE64, with a further modification from
[UTF\-7] that "," is used instead of "/".  Modified BASE64 MUST NOT be used to
represent any printing US-ASCII character which can represent itself.
.PP
"&" is used to shift to modified BASE64 and "\-" to shift back to US\- ASCII.
All names start in US-ASCII, and MUST end in US-ASCII (that is, a name that
ends with a Unicode 16\-bit octet MUST end with a "\- ").
.PP
For example, here is a mailbox name which mixes English, Japanese,
and Chinese text: \f(CW\*(C`~peter/mail/&ZeVnLIqe\-/&U,BTFw\-\*(C'\fR
.SH AUTHOR
.IX Header "AUTHOR"
Sava Chankov <sava@cpan.org>
.SH CONTRIBUTOR
.IX Header "CONTRIBUTOR"
Ricardo Signes <rjbs@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2005 by Sava Chankov.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.