php-doc-en/reference/imap/functions/imap-utf7-decode.xml
2003-05-07 21:31:31 +00:00

55 lines
1.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.16 -->
<refentry id="function.imap-utf7-decode">
<refnamediv>
<refname>imap_utf7_decode</refname>
<refpurpose>
Decodes a modified UTF-7 encoded string.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>imap_utf7_decode</methodname>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
Decodes modified UTF-7 <parameter>text</parameter> into ISO-8859-1 string.
</para>
<para>
Returns a string that is encoded in ISO-8859-1 and consists of the same
sequence of characters in <parameter>text</parameter>, or &false;
if <parameter>text</parameter> contains invalid modified UTF-7 sequence
or <parameter>text</parameter> contains a character that is not part of
ISO-8859-1 character set.
This function is needed to decode mailbox names that contain certain
characters which are not in range of printable ASCII characters.
The modified UTF-7 encoding is defined in
<ulink url="&url.rfc;2060">RFC 2060</ulink>, section
5.1.3 (original UTF-7 was defned in <ulink
url="&url.rfc;1642">RFC1642</ulink>).
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->