php-doc-en/reference/imap/functions/imap-utf7-decode.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

78 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.imap-utf7-decode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>imap_utf7_decode</refname>
<refpurpose>Decodes a modified UTF-7 encoded string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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>
This function is needed to decode mailbox names that contain certain
characters which are not in range of printable ASCII characters.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem>
<para>
A modified UTF-7 encoding string, as defined in <link
xlink:href="&url.rfc;2060">RFC 2060</link>, section 5.1.3 (original UTF-7
was defined in <link xlink:href="&url.rfc;1642">RFC1642</link>).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<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.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_utf7_encode</function></member>
</simplelist>
</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:"~/.phpdoc/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
-->