mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-22 03:48:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
123 lines
3.3 KiB
XML
123 lines
3.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.imap-mail-compose" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>imap_mail_compose</refname>
|
|
<refpurpose>Create a MIME message based on given envelope and body sections</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>imap_mail_compose</methodname>
|
|
<methodparam><type>array</type><parameter>envelope</parameter></methodparam>
|
|
<methodparam><type>array</type><parameter>body</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Create a MIME message based on the given <parameter>envelope</parameter>
|
|
and <parameter>body</parameter> sections.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>envelope</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An associative array of headers fields. Valid keys are: "remail",
|
|
"return_path", "date", "from", "reply_to", "in_reply_to", "subject",
|
|
"to", "cc", "bcc", "message_id" and "custom_headers" (which contains
|
|
associative array of other headers).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>body</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An indexed array of bodies
|
|
</para>
|
|
<para>
|
|
A body is an associative array which can consist of the following keys:
|
|
"type", "encoding", "charset", "type.parameters", "subtype", "id",
|
|
"description", "disposition.type", "disposition", "contents.data",
|
|
"lines", "bytes" and "md5".
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the MIME message.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>imap_mail_compose</function> example</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
|
|
-->
|