moriyoshi Mon Mar 15 15:36:58 2004 EDT
Modified files:
/phpdoc/en/reference/mbstring/functions mb-encode-mimeheader.xml
Log:
- Fix bug #23192
http://cvs.php.net/diff.php/phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml
diff -u phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.4
phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.5
--- phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml:1.4 Tue Dec 23
18:50:54 2003
+++ phpdoc/en/reference/mbstring/functions/mb-encode-mimeheader.xml Mon Mar 15
15:36:58 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.1 -->
<refentry id="function.mb-encode-mimeheader">
<refnamediv>
@@ -16,23 +16,28 @@
<methodparam
choice="opt"><type>string</type><parameter>linefeed</parameter></methodparam>
</methodsynopsis>
<para>
- <function>mb_encode_mimeheader</function> converts string
- <parameter>str</parameter> to encoded-word for header field.
- It returns converted string in ASCII encoding.
+ <function>mb_encode_mimeheader</function> encodes a given string
+ <parameter>str</parameter> by the MIME header encoding scheme.
+ Returns a converted version of the string represented in ASCII.
</para>
<para>
- <parameter>charset</parameter> is character encoding
- name. Default is <literal>ISO-2022-JP</literal>.
+ <parameter>charset</parameter> specifies the name of the character set
+ in which <parameter>str</parameter> is represented in. The default value
+ is determined by the current NLS setting (<literal>mbstring.language</literal>).
</para>
<para>
- <parameter>transfer-encoding</parameter> is transfer encoding. It
- should be one of <literal>"B"</literal> (Base64) or
- <literal>"Q"</literal> (Quoted-Printable). Default is
- <literal>"B"</literal>.
+ <parameter>transfer-encoding</parameter> specifies the scheme of MIME
+ encoding. It should be either <literal>"B"</literal> (Base64) or
+ <literal>"Q"</literal> (Quoted-Printable). Falls back to
+ <literal>"B"</literal> if not given.
</para>
<para>
- <parameter>linefeed</parameter> is end of line marker. Default is
- <literal>"\r\n"</literal> (CRLF).
+ <parameter>linefeed</parameter> specifies the EOL (end-of-line) marker
+ with which <function>mb_encode_mime_header</function> performs
+ line-folding (a <ulink url="&url.rfc;2822">RFC</ulink> term,
+ the act of breaking a line longer than a certain length into multiple
+ lines. The length is currently hard-coded to 74 characters).
+ Falls back to <literal>"\r\n"</literal> (CRLF) if not given.
</para>
<para>
<example>
@@ -50,6 +55,13 @@
</programlisting>
</example>
</para>
+ <note>
+ <para>
+ This function isn't designed to break lines at higher-level
+ contextual break points (word boundaries, etc.).
+ This behaviour may clutter up the original string with unexpected spaces.
+ </para>
+ </note>
<para>
See also <function>mb_decode_mimeheader</function>.
</para>
