git.maemo.org Git - modest/blob - 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 <!-- ##### SIGNAL ModestMailOperation::progress-changed ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @:
  78
  79 <!-- ##### FUNCTION modest_mail_operation_new ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION modest_mail_operation_send_mail ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @self:
  93 @transport_account:
  94 @msg:
  95
  96
  97 <!-- ##### FUNCTION modest_mail_operation_send_new_mail ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @self:
 103 @transport_account:
 104 @from:
 105 @to:
 106 @cc:
 107 @bcc:
 108 @subject:
 109 @body:
 110 @attachments_list:
 111
 112
 113 <!-- ##### FUNCTION modest_mail_operation_create_forward_mail ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @msg:
 119 @from:
 120 @forward_type:
 121 @Returns:
 122
 123
 124 <!-- ##### FUNCTION modest_mail_operation_create_reply_mail ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @msg:
 130 @from:
 131 @reply_type:
 132 @reply_mode:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION modest_mail_operation_update_account ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @self:
 142 @store_account:
 143 @Returns:
 144
 145
 146 <!-- ##### FUNCTION modest_mail_operation_create_folder ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @self:
 152 @parent:
 153 @name:
 154 @Returns:
 155
 156
 157 <!-- ##### FUNCTION modest_mail_operation_remove_folder ##### -->
 158 <para>
 159
 160 </para>
 161
 162 @self:
 163 @folder:
 164 @remove_to_trash:
 165
 166
 167 <!-- ##### FUNCTION modest_mail_operation_rename_folder ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @self:
 173 @folder:
 174 @name:
 175
 176
 177 <!-- ##### FUNCTION modest_mail_operation_move_folder ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @self:
 183 @folder:
 184 @parent:
 185
 186
 187 <!-- ##### FUNCTION modest_mail_operation_copy_folder ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @self:
 193 @folder:
 194 @parent:
 195
 196
 197 <!-- ##### FUNCTION modest_mail_operation_copy_msg ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @self:
 203 @header:
 204 @folder:
 205 @Returns:
 206
 207
 208 <!-- ##### FUNCTION modest_mail_operation_move_msg ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @self:
 214 @header:
 215 @folder:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION modest_mail_operation_remove_msg ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @self:
 225 @header:
 226 @remove_to_trash:
 227
 228
 229 <!-- ##### FUNCTION modest_mail_operation_get_task_done ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @self:
 235 @Returns:
 236
 237
 238 <!-- ##### FUNCTION modest_mail_operation_get_task_total ##### -->
 239 <para>
 240
 241 </para>
 242
 243 @self:
 244 @Returns:
 245
 246
 247 <!-- ##### FUNCTION modest_mail_operation_is_finished ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @self:
 253 @Returns:
 254
 255
 256 <!-- ##### FUNCTION modest_mail_operation_get_status ##### -->
 257 <para>
 258
 259 </para>
 260
 261 @self:
 262 @Returns:
 263
 264
 265 <!-- ##### FUNCTION modest_mail_operation_get_error ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @self:
 271 @Returns:
 272
 273
 274 <!-- ##### FUNCTION modest_mail_operation_cancel ##### -->
 275 <para>
 276
 277 </para>
 278
 279 @self:
 280 @Returns:
 281
 282