-
Notifications
You must be signed in to change notification settings - Fork 149
/
imap-savebody.xml
137 lines (135 loc) · 4 KB
/
imap-savebody.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.imap-savebody" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>imap_savebody</refname>
<refpurpose>Sauvegarde une partie spécifique du corps dans un fichier</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>imap_savebody</methodname>
<methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
<methodparam><type class="union"><type>resource</type><type>string</type><type>int</type></type><parameter>file</parameter></methodparam>
<methodparam><type>int</type><parameter>message_num</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>section</parameter><initializer>""</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Sauvegarde une partie du corps du message spécifié.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&imap.imap-parameter.imap;
<varlistentry>
<term><parameter>file</parameter></term>
<listitem>
<para>
Le chemin vers le fichier de sauvegarde, sous la forme d'une &string;
ou un descripteur de fichier valide retourné par la fonction
<function>fopen</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>message_num</parameter></term>
<listitem>
<para>
Le numéro du message
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>section</parameter></term>
<listitem>
<para>
Le numéro de la section. C'est une &string; d'entiers, délimités par
une virgule qui correspondent à l'index dans la liste des sections
du corps, tel que prévu par la spécification IMAP4.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
Un masque qui contient une ou plusieurs des valeurs suivantes :
<itemizedlist>
<listitem>
<simpara>
<constant>FT_UID</constant> - Le numéro <parameter>message_num</parameter> est un UID
</simpara>
</listitem>
<listitem>
<simpara>
<constant>FT_PEEK</constant> - Ne pas définir le drapeau \Seen s'il n'est pas déjà défini
</simpara>
</listitem>
<listitem>
<simpara>
<constant>FT_INTERNAL</constant> - La &string; retournée est dans un format interne, qui
ne correspondant pas à CRLF.
</simpara>
</listitem>
</itemizedlist>
</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;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>imap_fetchbody</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
-->