1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-mime-decode">
<refnamediv>
<refname>iconv_mime_decode</refname>
<refpurpose>
Decodes a <literal>MIME</literal> header field
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>iconv_mime_decode</methodname>
<methodparam><type>string</type><parameter>encoded_header</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Returns a decoded <literal>MIME</literal> field on success,
or &false; if an error occurs during the decoding.
</para>
<para>
<parameter>mode</parameter> determines the behaviour in the event
<function>iconv_mime_decode</function> encounters a malformed
<literal>MIME</literal> header field. You can specify any combination
of the following bitmasks.
<table>
<title>Bitmasks acceptable to <function>iconv_mime_decode</function></title>
<tgroup cols="3">
<thead>
<row>
<entry>Value</entry>
<entry>Constant</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>ICONV_MIME_DECODE_STRICT</entry>
<entry>
If set, the given header is decoded in full conformance with the
standards defined in <ulink url="&url.rfc;2047">RFC2047</ulink>.
This option is disabled by default because there are a lot of
broken mail user agents that don't follow the specification and don't
produce correct <literal>MIME</literal> headers.
</entry>
</row>
<row>
<entry>2</entry>
<entry>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</entry>
<entry>
If set, <function>iconv_mime_decode</function> attempts to continue
to process the given header even though an error occurs.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
The optional <parameter>charset</parameter> parameter specifies the
character set to represent the result by. If omitted,
<link linkend="iconv.configuration">iconv.internal_charset</link>
will be used.
</para>
<example>
<title><function>iconv_mime_decode</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// This yields "Subject: Prfung Prfung"
echo iconv_mime_decode("Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=",
0, "ISO-8859-1");
?>
]]>
</programlisting>
</example>
<para>
See also <function>iconv_mime_decode_headers</function>,
<function>mb_decode_mimeheader</function>,
<function>imap_mime_header_decode</function>,
<function>imap_base64</function>
and <function>imap_qprint</function>.
</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
-->
|
