-
Notifications
You must be signed in to change notification settings - Fork 39
/
imap-append.xml
162 lines (153 loc) · 4.78 KB
/
imap-append.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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Reviewer: samesch -->
<refentry xml:id="function.imap-append" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_append</refname>
<refpurpose>Hängt eine String-Nachricht an ein Postfach an</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imap_append</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type>string</type><parameter>folder</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>internal_date</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Der in <parameter>message</parameter> übergebene String wird als Nachricht
an das Postfach <parameter>folder</parameter> angefügt.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>folder</parameter></term>
<listitem>
<para>
Der Name des Postfachs, siehe <function>imap_open</function> für nähere
Informationen
</para>
&imap.mailboxname.insecure;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<para>
Die anzufügende Nachricht als String
</para>
<para>
Bei Verbindungen mit dem Cyrus-IMAP-Server ist es zwingend
erforderlich, "\r\n" als Zeilenende zu verwenden. Mit einem einfachen
"\n" schlägt die Operation fehl.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Wenn angegeben, werden die in <parameter>options</parameter> gesetzten
Optionen auch ins Postfach <parameter>folder</parameter> geschrieben.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>internal_date</parameter></term>
<listitem>
<para>
Wenn dieser Parameter angegeben wird, wird das INTERNALDATE für die
hinzugefügte Nachricht gesetzt. Der Parameter sollte ein Datumsstring
sein, der den rfc2060-Spezifikationen für einen date_time-Wert
entspricht.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&imap.changelog.imap-param;
<row>
<entry>8.0.0</entry>
<entry>
<parameter>options</parameter> und <parameter>internal_date</parameter>
sind jetzt nullable (akzeptieren den &null;-Wert).
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>imap_append</function>-Beispiel</title>
<programlisting role="php">
<![CDATA[
<?php
$imap = imap_open("{imap.example.org}INBOX.Drafts", "username", "password");
$check = imap_check($imap);
echo "Anzahl der Nachrichten vor dem Anhängen: ". $check->Nmsgs . "\n";
imap_append($imap, "{imap.example.org}INBOX.Drafts"
, "From: me@example.com\r\n"
. "To: you@example.com\r\n"
. "Subject: test\r\n"
. "\r\n"
. "this is a test message, please ignore\r\n"
);
$check = imap_check($imap);
echo "Anzahl der Nachrichten nach dem Anhängen: ". $check->Nmsgs . "\n";
imap_close($imap);
?>
]]>
</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
-->