php-doc-en/reference/mbstring/functions/mb-encode-mimeheader.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.mb-encode-mimeheader" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>mb_encode_mimeheader</refname>
  <refpurpose>Encode string for MIME header</refpurpose>
 </refnamediv>
   
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>mb_encode_mimeheader</methodname>
   <methodparam><type>string</type><parameter>str</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>charset</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>transfer_encoding</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>linefeed</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>indent</parameter></methodparam>
  </methodsynopsis>
  <para>
   Encodes a given <type>string</type>
   <parameter>str</parameter> by the MIME header encoding scheme.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>str</parameter></term>
     <listitem>
      <para>
       The <type>string</type> being encoded.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>charset</parameter></term>
     <listitem>
      <para>
       <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>).
       <function>mb_internal_encoding</function> should be set to same encoding.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>transfer_encoding</parameter></term>
     <listitem>
      <para>
       <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>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>linefeed</parameter></term>
     <listitem>
      <para>
       <parameter>linefeed</parameter> specifies the EOL (end-of-line) marker
       with which <function>mb_encode_mimeheader</function> performs
       line-folding (a <link xlink:href="&url.rfc;2822">RFC</link> 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>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>indent</parameter></term>
     <listitem>
      <para>
       Indentation of the first line (number of characters in the header
       before <parameter>str</parameter>).
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A converted version of the <type>string</type> represented in ASCII.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.0.0</entry>
       <entry>
        The <parameter>indent</parameter> parameter was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>mb_encode_mimeheader</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$name = ""; // kanji
$mbox = "kru";
$doma = "gtinn.mon";
$addr = mb_encode_mimeheader($name, "UTF-7", "Q") . " <" . $mbox . "@" . $doma . ">";
echo $addr;
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <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>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>mb_decode_mimeheader</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:"../../../../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
-->