iconv-mime-encode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ab9a7d2e3dfa9224186abcbd7a43b3af08d1bfdb Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.iconv-mime-encode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>iconv_mime_encode</refname>
  <refpurpose><literal>MIME</literal> ヘッダフィールドを作成する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>iconv_mime_encode</methodname>
   <methodparam><type>string</type><parameter>field_name</parameter></methodparam>
   <methodparam><type>string</type><parameter>field_value</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   有効な <literal>MIME</literal> ヘッダフィールドを作成し、返します。
   これは以下のような形式になります。
   <screen>
<![CDATA[
Subject: =?ISO-8859-1?Q?Pr=FCfung_f=FCr?= Entwerfen von einer MIME kopfzeile
]]>
   </screen>
   上の例では "Subject" がフィールド名、"=?ISO-8859-1?..." で始まる部分が
   フィールドの値となります。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>field_name</parameter></term>
     <listitem>
      <para>
       フィールド名。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>field_value</parameter></term>
     <listitem>
      <para>
       フィールドの値。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       <function>iconv_mime_encode</function> の振る舞いを変更するには、
       ここで設定項目を含む連想配列を指定します。
       <function>iconv_mime_encode</function> でサポートされている項目は
       以下のとおりです。項目名の大文字・小文字は区別されることに注意してください。
       <table>
        <title><function>iconv_mime_encode</function> でサポートされる設定項目</title>
        <tgroup cols="5">
         <thead>
          <row>
           <entry>項目</entry>
           <entry>型</entry>
           <entry>説明</entry>
           <entry>デフォルト値</entry>
           <entry>例</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry>scheme</entry>
           <entry><type>string</type></entry>
           <entry>
            フィールドの値のエンコード方法を指定します。"B" か "Q" の
            どちらかを指定することになるでしょう。"B" は
            <literal>base64</literal> エンコードを、また "Q" は
            <literal>quoted-printable</literal> エンコードを表します。
           </entry>
           <entry>B</entry>
           <entry>B</entry>
          </row>
          <row>
           <entry>input-charset</entry>
           <entry><type>string</type></entry>
           <entry>
            第 1 パラメータ <parameter>field_name</parameter> と第 2 パラメータ
            <parameter>field_value</parameter> の文字セットを指定します。
            指定されなかった場合は、<function>iconv_mime_encode</function>
            は ini 設定
            <link linkend="iconv.configuration">iconv.internal_encoding</link>
            であると仮定します。
           </entry>
           <entry>
            <link linkend="iconv.configuration">iconv.internal_encoding</link>
           </entry>
           <entry>ISO-8859-1</entry>
          </row>
          <row>
           <entry>output-charset</entry>
           <entry><type>string</type></entry>
           <entry>
            <literal>MIME</literal> ヘッダを作成する文字セットを指定します。
           </entry>
           <entry>
            <link linkend="iconv.configuration">iconv.internal_encoding</link>
           </entry>
           <entry>UTF-8</entry>
          </row>
          <row>
           <entry>line-length</entry>
           <entry><type>int</type></entry>
           <entry>
            ヘッダ行の長さの最大値を指定します。もし結果がこの値より
            長くなった場合は、
            <link xlink:href="&url.rfc;2822">RFC2822 - Internet Message Format</link>
            に基づいてヘッダを "折りたたんで" 複数行に分割します。
            指定されなかった場合は、長さは 76 文字に限定されます。
           </entry>
           <entry>76</entry>
           <entry>996</entry>
          </row>
          <row>
           <entry>line-break-chars</entry>
           <entry><type>string</type></entry>
           <entry>
            長いヘッダフィールドに対して "折りたたみ" 処理が行われる場合に
            個々の行の後ろに付加される文字列を指定します。
            指定されなかった場合は、"\r\n"
            （<literal>CR</literal> <literal>LF</literal>）が用いられます。
            このパラメータは、<literal>input-charset</literal> の値にかかわらず
            常に ASCII 文字列として扱われることに注意してください。
           </entry>
           <entry>\r\n</entry>
           <entry>\n</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合はエンコードした <literal>MIME</literal> フィールド、
   エンコード時にエラーが発生した場合は &false; を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>iconv_mime_encode</function> の例:</title>
    <programlisting role="php">
<![CDATA[
<?php
$preferences = array(
    "input-charset" => "ISO-8859-1",
    "output-charset" => "UTF-8",
    "line-length" => 76,
    "line-break-chars" => "\n"
);
$preferences["scheme"] = "Q";
// この結果は "Subject: =?UTF-8?Q?Pr=C3=BCfung=20Pr=C3=BCfung?=" となります。
echo iconv_mime_encode("Subject", "Prüfung Prüfung", $preferences);

$preferences["scheme"] = "B";
// この結果は "Subject: =?UTF-8?B?UHLDvGZ1bmcgUHLDvGZ1bmc=?=" となります。
echo iconv_mime_encode("Subject", "Prüfung Prüfung", $preferences);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>imap_binary</function></member>
    <member><function>mb_encode_mimeheader</function></member>
    <member><function>imap_8bit</function></member>
    <member><function>quoted_printable_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
-->