* Splitted the main documentation file in some smaller ones
[modest] / docs / reference / tmpl / modest-mail-operation.sgml
1 <!-- ##### SECTION Title ##### -->
2 ModestMailOperation
3
4 <!-- ##### SECTION Short_Description ##### -->
5
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9
10 </para>
11
12
13 <!-- ##### SECTION See_Also ##### -->
14 <para>
15
16 </para>
17
18
19 <!-- ##### SECTION Stability_Level ##### -->
20
21
22 <!-- ##### ENUM ModestMailOperationForwardType ##### -->
23 <para>
24
25 </para>
26
27 @MODEST_MAIL_OPERATION_FORWARD_TYPE_INLINE: 
28 @MODEST_MAIL_OPERATION_FORWARD_TYPE_ATTACHMENT: 
29
30 <!-- ##### ENUM ModestMailOperationReplyType ##### -->
31 <para>
32
33 </para>
34
35 @MODEST_MAIL_OPERATION_REPLY_TYPE_CITE: 
36 @MODEST_MAIL_OPERATION_REPLY_TYPE_QUOTE: 
37
38 <!-- ##### ENUM ModestMailOperationReplyMode ##### -->
39 <para>
40
41 </para>
42
43 @MODEST_MAIL_OPERATION_REPLY_MODE_SENDER: 
44 @MODEST_MAIL_OPERATION_REPLY_MODE_LIST: 
45 @MODEST_MAIL_OPERATION_REPLY_MODE_ALL: 
46
47 <!-- ##### ENUM ModestMailOperationStatus ##### -->
48 <para>
49
50 </para>
51
52 @MODEST_MAIL_OPERATION_STATUS_INVALID: 
53 @MODEST_MAIL_OPERATION_STATUS_SUCCESS: 
54 @MODEST_MAIL_OPERATION_STATUS_FINISHED_WITH_ERRORS: 
55 @MODEST_MAIL_OPERATION_STATUS_FAILED: 
56 @MODEST_MAIL_OPERATION_STATUS_IN_PROGRESS: 
57 @MODEST_MAIL_OPERATION_STATUS_CANCELED: 
58
59 <!-- ##### STRUCT ModestMailOperation ##### -->
60 <para>
61
62 </para>
63
64
65 <!-- ##### SIGNAL ModestMailOperation::progress-changed ##### -->
66 <para>
67
68 </para>
69
70 @: 
71
72 <!-- ##### FUNCTION modest_mail_operation_new ##### -->
73 <para>
74
75 </para>
76
77 @Returns: 
78
79
80 <!-- ##### FUNCTION modest_mail_operation_send_mail ##### -->
81 <para>
82
83 </para>
84
85 @self: 
86 @transport_account: 
87 @msg: 
88
89
90 <!-- ##### FUNCTION modest_mail_operation_send_new_mail ##### -->
91 <para>
92
93 </para>
94
95 @self: 
96 @transport_account: 
97 @from: 
98 @to: 
99 @cc: 
100 @bcc: 
101 @subject: 
102 @body: 
103 @attachments_list: 
104
105
106 <!-- ##### FUNCTION modest_mail_operation_create_forward_mail ##### -->
107 <para>
108
109 </para>
110
111 @msg: 
112 @from: 
113 @forward_type: 
114 @Returns: 
115
116
117 <!-- ##### FUNCTION modest_mail_operation_create_reply_mail ##### -->
118 <para>
119
120 </para>
121
122 @msg: 
123 @from: 
124 @reply_type: 
125 @reply_mode: 
126 @Returns: 
127
128
129 <!-- ##### FUNCTION modest_mail_operation_update_account ##### -->
130 <para>
131
132 </para>
133
134 @self: 
135 @store_account: 
136 @Returns: 
137
138
139 <!-- ##### FUNCTION modest_mail_operation_create_folder ##### -->
140 <para>
141
142 </para>
143
144 @self: 
145 @parent: 
146 @name: 
147 @Returns: 
148
149
150 <!-- ##### FUNCTION modest_mail_operation_remove_folder ##### -->
151 <para>
152
153 </para>
154
155 @self: 
156 @folder: 
157 @remove_to_trash: 
158
159
160 <!-- ##### FUNCTION modest_mail_operation_rename_folder ##### -->
161 <para>
162
163 </para>
164
165 @self: 
166 @folder: 
167 @name: 
168
169
170 <!-- ##### FUNCTION modest_mail_operation_move_folder ##### -->
171 <para>
172
173 </para>
174
175 @self: 
176 @folder: 
177 @parent: 
178
179
180 <!-- ##### FUNCTION modest_mail_operation_copy_folder ##### -->
181 <para>
182
183 </para>
184
185 @self: 
186 @folder: 
187 @parent: 
188
189
190 <!-- ##### FUNCTION modest_mail_operation_copy_msg ##### -->
191 <para>
192
193 </para>
194
195 @self: 
196 @header: 
197 @folder: 
198 @Returns: 
199
200
201 <!-- ##### FUNCTION modest_mail_operation_move_msg ##### -->
202 <para>
203
204 </para>
205
206 @self: 
207 @header: 
208 @folder: 
209 @Returns: 
210
211
212 <!-- ##### FUNCTION modest_mail_operation_remove_msg ##### -->
213 <para>
214
215 </para>
216
217 @self: 
218 @header: 
219 @remove_to_trash: 
220
221
222 <!-- ##### FUNCTION modest_mail_operation_get_task_done ##### -->
223 <para>
224
225 </para>
226
227 @self: 
228 @Returns: 
229
230
231 <!-- ##### FUNCTION modest_mail_operation_get_task_total ##### -->
232 <para>
233
234 </para>
235
236 @self: 
237 @Returns: 
238
239
240 <!-- ##### FUNCTION modest_mail_operation_is_finished ##### -->
241 <para>
242
243 </para>
244
245 @self: 
246 @Returns: 
247
248
249 <!-- ##### FUNCTION modest_mail_operation_get_status ##### -->
250 <para>
251
252 </para>
253
254 @self: 
255 @Returns: 
256
257
258 <!-- ##### FUNCTION modest_mail_operation_get_error ##### -->
259 <para>
260
261 </para>
262
263 @self: 
264 @Returns: 
265
266
267 <!-- ##### FUNCTION modest_mail_operation_cancel ##### -->
268 <para>
269
270 </para>
271
272 @self: 
273 @Returns: 
274
275