imap-mail-compose.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: hirokawa Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.imap-mail-compose" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>imap_mail_compose</refname>
  <refpurpose>
   指定したエンベロープおよびボディセクションに基づいて
   MIME メッセージを作成する
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>imap_mail_compose</methodname>
   <methodparam><type>array</type><parameter>envelope</parameter></methodparam>
   <methodparam><type>array</type><parameter>bodies</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定したエンベロープ <parameter>envelope</parameter>
   およびボディセクション <parameter>bodies</parameter> に基づいて
   MIME メッセージを作成します。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>envelope</parameter></term>
     <listitem>
      <para>
       ヘッダフィールドの連想配列。使えるキーは
       <literal>"remail"</literal>,
       <literal>"return_path"</literal>,
       <literal>"date"</literal>, <literal>"from"</literal>, <literal>"reply_to"</literal>,
       <literal>"in_reply_to"</literal>, <literal>"subject"</literal>,
       <literal>"to"</literal>, <literal>"cc"</literal>, <literal>"bcc"</literal>。
       <literal>"message_id"</literal>。
       これらの値は、連想配列の値に与えられた文字列でそれぞれのヘッダを設定します。
       さらに追加のヘッダを設定する用途として、
       <literal>"custom_headers"</literal> がサポートされています。
       ここには、その他のヘッダの連想配列を指定します。例: <code>["User-Agent: My Mail Client"]</code>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>bodies</parameter></term>
     <listitem>
      <para>
       本文の配列。
       配列の最初の要素が、メッセージの中心部分です。
       <constant>TYPEMULTIPART</constant> の場合にだけ、ふたつめ以降の要素が処理されます。
       処理された要素は、本文の一部を構成します。
      </para>
      <para>
       <table>
        <title>body に指定する配列の構造</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>キー</entry>
           <entry>型</entry>
           <entry>説明</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>type</literal></entry>
           <entry><type>int</type></entry>
           <entry>
            MIMEタイプ。
            <constant>TYPETEXT</constant> (デフォルト), <constant>TYPEMULTIPART</constant>,
            <constant>TYPEMESSAGE</constant>, <constant>TYPEAPPLICATION</constant>,
            <constant>TYPEAUDIO</constant>, <constant>TYPEIMAGE</constant>,
            <constant>TYPEMODEL</constant>, <constant>TYPEOTHER</constant> が指定できます。
           </entry>
          </row>
          <row>
           <entry><literal>encoding</literal></entry>
           <entry><type>int</type></entry>
           <entry>
            <literal>Content-Transfer-Encoding</literal> の値を指定します。
            <constant>ENC7BIT</constant> (デフォルト), <constant>ENC8BIT</constant>,
            <constant>ENCBINARY</constant>, <constant>ENCBASE64</constant>,
            <constant>ENCQUOTEDPRINTABLE</constant>, <constant>ENCOTHER</constant> が指定できます。
           </entry>
          </row>
          <row>
           <entry><literal>charset</literal></entry>
           <entry><type>string</type></entry>
           <entry>MIMEタイプの charset パラメータの値</entry>
          </row>
          <row>
           <entry><literal>type.parameters</literal></entry>
           <entry><type>array</type></entry>
           <entry><literal>Content-Type</literal> の名前と値を連想配列で指定します。</entry>
          </row>
          <row>
           <entry><literal>subtype</literal></entry>
           <entry><type>string</type></entry>
           <entry>MIMEサブタイプ。例: <constant>TYPEIMAGE</constant> の場合は <literal>'jpeg'</literal></entry>
          </row>
          <row>
           <entry><literal>id</literal></entry>
           <entry><type>string</type></entry>
           <entry><literal>Content-ID</literal> の値</entry>
          </row>
          <row>
           <entry><literal>description</literal></entry>
           <entry><type>string</type></entry>
           <entry><literal>Content-Description</literal> の値</entry>
          </row>
          <row>
           <entry><literal>disposition.type</literal></entry>
           <entry><type>string</type></entry>
           <entry><literal>Content-Disposition</literal> の値。例: <literal>'attachment'</literal></entry>
          </row>
          <row>
           <entry><literal>disposition</literal></entry>
           <entry><type>array</type></entry>
           <entry><literal>Content-Disposition</literal> の名前と値を連想配列で指定します。</entry>
          </row>
          <row>
           <entry><literal>contents.data</literal></entry>
           <entry><type>string</type></entry>
           <entry>ペイロード</entry>
          </row>
          <row>
           <entry><literal>lines</literal></entry>
           <entry><type>int</type></entry>
           <entry>The size of the payload in lines.</entry>
          </row>
          <row>
           <entry><literal>bytes</literal></entry>
           <entry><type>int</type></entry>
           <entry>ペイロードのサイズをバイト単位で指定します。</entry>
          </row>
          <row>
           <entry><literal>md5</literal></entry>
           <entry><type>string</type></entry>
           <entry>ペイロードのMD5チェックサム</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   MIME メッセージを文字列として返します。
   &return.falseforfailure;
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>imap_mail_compose</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

$envelope["from"]= "joe@example.com";
$envelope["to"]  = "foo@example.com";
$envelope["cc"]  = "bar@example.com";

$part1["type"] = TYPEMULTIPART;
$part1["subtype"] = "mixed";

$filename = "/tmp/imap.c.gz";
$fp = fopen($filename, "r");
$contents = fread($fp, filesize($filename));
fclose($fp);

$part2["type"] = TYPEAPPLICATION;
$part2["encoding"] = ENCBINARY;
$part2["subtype"] = "octet-stream";
$part2["description"] = basename($filename);
$part2["contents.data"] = $contents;

$part3["type"] = TYPETEXT;
$part3["subtype"] = "plain";
$part3["description"] = "description3";
$part3["contents.data"] = "contents.data3\n\n\n\t";

$body[1] = $part1;
$body[2] = $part2;
$body[3] = $part3;

echo nl2br(imap_mail_compose($envelope, $body));

?>
]]>
    </programlisting>
   </example>
  </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
-->