<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 398329d3c680e8eccd694a6a3f7fe1ebd929ea80 Maintainer: hirokawa Status: ready -->

<!-- CREDITS: takagi,mumumu -->

<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>MIMEヘッダの文字列をエンコードする</refpurpose>

</refnamediv>

<refsect1 role="description">

&reftitle.description;

<methodsynopsis>

<type>string</type><methodname>mb_encode_mimeheader</methodname>

<methodparam><type>string</type><parameter>string</parameter></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>charset</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>transfer_encoding</parameter><initializer>&null;</initializer></methodparam>

<methodparam choice="opt"><type>string</type><parameter>newline</parameter><initializer>"\r\n"</initializer></methodparam>

<methodparam choice="opt"><type>int</type><parameter>indent</parameter><initializer>0</initializer></methodparam>

</methodsynopsis>

<para>

MIME ヘッダエンコーディング方式によって文字列 <parameter>string</parameter>

をエンコードします。

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>string</parameter></term>

<listitem>

<para>

エンコードする文字列。

<function>mb_internal_encoding</function> と同じエンコーディングにしなければいけません。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>charset</parameter></term>

<listitem>

<para>

<parameter>charset</parameter> は、<parameter>string</parameter>

の変換後の文字セット名です。デフォルトは、現在の NLS 設定

(<literal>mbstring.language</literal>) によって決まります。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>transfer_encoding</parameter></term>

<listitem>

<para>

<parameter>transfer_encoding</parameter> は MIME エンコーディングの

方式を指定します。<literal>"B"</literal> (Base64) または

<literal>"Q"</literal> (Quoted-Printable) のどちらかでなければなりません。

デフォルトは <literal>"B"</literal> です。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>newline</parameter></term>

<listitem>

<para>

<parameter>newline</parameter> は EOL (行末) のマーカで、

<function>mb_encode_mimeheader</function> が行を折りたたむ

(<link xlink:href="&url.rfc;2822">RFC</link> 用語で、

ある一定より長い行を複数行に分割することを言います。

分割する長さは、現在 74 文字に固定されています) 際に利用します。

デフォルトは <literal>"\r\n"</literal> (CRLF) です。

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>indent</parameter></term>

<listitem>

<para>

最初の行の字下げ (ヘッダで

<parameter>string</parameter> の前におく文字数)。

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

文字列を ASCII 表現に変換したものを返します。

</para>

</refsect1>

<refsect1 role="changelog">

&reftitle.changelog;

<informaltable>

<tgroup cols="2">

<thead>

<row>

<entry>&Version;</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>8.3.0</entry>

<entry>

<literal>NUL</literal> (0) バイトは、

Quoted-Printable エンコーディングを用いた場合でも削除されなくなりました。

代わりに、<literal>=00</literal> でエンコードされます。

</entry>

</row>

<row>

<entry>8.0.0</entry>

<entry>

<parameter>charset</parameter> と <parameter>transfer_encoding</parameter> は、

nullable になりました。

</entry>

</row>

</tbody>

</tgroup>

</informaltable>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title><function>mb_encode_mimeheader</function> の例</title>

<programlisting role="php">

<![CDATA[

<?php

$name = "太郎"; // 漢字

$mbox = "kru";

$doma = "gtinn.mon";

$addr = '"' . addcslashes(mb_encode_mimeheader($name, "UTF-7", "Q"), '"') . '" <' . $mbox . "@" . $doma . ">";

echo $addr;

?>

]]>

</programlisting>

&example.outputs;

<screen>

<![CDATA[

"=?UTF-7?Q?+WSqQzg-?=" <[email protected]>

]]>

</screen>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<note>

<para>

この関数は、行を分割する際に特別な配慮（単語の区切りなど）を行いません。

このせいで、もとの文字列に予期せぬ空白が入ってしまう可能性があります。

</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:"~/.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

-->