-
Notifications
You must be signed in to change notification settings - Fork 39
/
imap-mail-compose.xml
243 lines (230 loc) · 7.81 KB
/
imap-mail-compose.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e2f50c240bebc502a3d990d73633a6141f3bd9fd Maintainer: hholzgra Status: ready -->
<refentry xml:id="function.imap-mail-compose" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_mail_compose</refname>
<refpurpose>Erzeugt eine MIME-Nachricht aus Kopf- und Nachrichtenelementen</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>
Erzeugt eine MIME-konforme Nachricht aus den in
<parameter>envelope</parameter> gegebenen Kopfelementen und den
Nachrichtenteilen aus <parameter>bodies</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>envelope</parameter></term>
<listitem>
<para>
Ein assoziatives Array von Kopfzeilenfeldern. Gültige Schlüssel sind:
<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> und
<literal>"message_id"</literal>, die die jeweiligen Kopfzeilen zum
angegebenen &string; definieren. Um zusätzliche Kopfzeilen zu
definieren, kann der Schlüssel <literal>"custom_headers"</literal>
verwendet werden, der ein Array von anderen Kopfzeilen erwartet, &zb;
<code>["User-Agent: Mein Mail-Client"]</code>).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bodies</parameter></term>
<listitem>
<para>
Ein Array mit dem Textkörper. Das erste Element des Arrays ist der
zentrale Teil der Nachricht. Nur wenn er vom Typ
<constant>TYPEMULTIPART</constant> ist, werden die weiteren Elemente
verarbeitet. Die verarbeiteten Elemente bilden die Teile des Körpers.
</para>
<para>
<table>
<title>Der Aufbau des Körper-Arrays</title>
<tgroup cols="2">
<thead>
<row>
<entry>Schlüssel</entry>
<entry>Typ</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>type</literal></entry>
<entry><type>int</type></entry>
<entry>
Der MIME-Typ. Entweder <constant>TYPETEXT</constant> (Standard),
<constant>TYPEMULTIPART</constant>,
<constant>TYPEMESSAGE</constant>,
<constant>TYPEAPPLICATION</constant>,
<constant>TYPEAUDIO</constant>, <constant>TYPEIMAGE</constant>,
<constant>TYPEMODEL</constant> oder
<constant>TYPEOTHER</constant>.
</entry>
</row>
<row>
<entry><literal>encoding</literal></entry>
<entry><type>int</type></entry>
<entry>
Das <literal>Content-Transfer-Encoding</literal>. Entweder
<constant>ENC7BIT</constant> (Standard),
<constant>ENC8BIT</constant>, <constant>ENCBINARY</constant>,
<constant>ENCBASE64</constant>,
<constant>ENCQUOTEDPRINTABLE</constant> oder
<constant>ENCOTHER</constant>.
</entry>
</row>
<row>
<entry><literal>charset</literal></entry>
<entry><type>string</type></entry>
<entry>Der Zeichensatz-Parameter des MIME-Typs.</entry>
</row>
<row>
<entry><literal>type.parameters</literal></entry>
<entry><type>array</type></entry>
<entry>
Ein assoziatives &array; von
<literal>Content-Type</literal>-Parameternamen und deren Werten.
</entry>
</row>
<row>
<entry><literal>subtype</literal></entry>
<entry><type>string</type></entry>
<entry>
Der MIME-Subtyp, &zb; <literal>'jpeg'</literal> für
<constant>TYPEIMAGE</constant>.
</entry>
</row>
<row>
<entry><literal>id</literal></entry>
<entry><type>string</type></entry>
<entry>Die <literal>Content-ID</literal>.</entry>
</row>
<row>
<entry><literal>description</literal></entry>
<entry><type>string</type></entry>
<entry>Die <literal>Content-Description</literal>.</entry>
</row>
<row>
<entry><literal>disposition.type</literal></entry>
<entry><type>string</type></entry>
<entry>
Die <literal>Content-Disposition</literal>, &zb;
<literal>'attachment'</literal>.
</entry>
</row>
<row>
<entry><literal>disposition</literal></entry>
<entry><type>array</type></entry>
<entry>
Ein assoziatives &array; von
<literal>Content-Disposition</literal>-Parameternamen und deren
Werten.
</entry>
</row>
<row>
<entry><literal>contents.data</literal></entry>
<entry><type>string</type></entry>
<entry>Der Inhalt.</entry>
</row>
<row>
<entry><literal>lines</literal></entry>
<entry><type>int</type></entry>
<entry>Die Größe des Inhalts in Zeilen.</entry>
</row>
<row>
<entry><literal>bytes</literal></entry>
<entry><type>int</type></entry>
<entry>Die Größe des Inhalts in Bytes.</entry>
</row>
<row>
<entry><literal>md5</literal></entry>
<entry><type>string</type></entry>
<entry>Die MD5-Prüfsumme des Inhalts.</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Gibt eine MIME-konforme Nachricht als &string; zurück.
&return.falseforfailure;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imap_mail_compose</function>-Beispiel</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
-->