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 @parent:
  65
  66 <!-- ##### FUNCTION modest_mail_operation_new ##### -->
  67 <para>
  68
  69 </para>
  70
  71 @Returns:
  72
  73
  74 <!-- ##### FUNCTION modest_mail_operation_send_mail ##### -->
  75 <para>
  76
  77 </para>
  78
  79 @self:
  80 @transport_account:
  81 @msg:
  82
  83
  84 <!-- ##### FUNCTION modest_mail_operation_send_new_mail ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @self:
  90 @transport_account:
  91 @from:
  92 @to:
  93 @cc:
  94 @bcc:
  95 @subject:
  96 @body:
  97 @attachments_list:
  98
  99
 100 <!-- ##### FUNCTION modest_mail_operation_create_forward_mail ##### -->
 101 <para>
 102
 103 </para>
 104
 105 @msg:
 106 @from:
 107 @forward_type:
 108 @Returns:
 109
 110
 111 <!-- ##### FUNCTION modest_mail_operation_create_reply_mail ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @msg:
 117 @from:
 118 @reply_type:
 119 @reply_mode:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION modest_mail_operation_update_account ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @self:
 129 @store_account:
 130 @Returns:
 131
 132
 133 <!-- ##### FUNCTION modest_mail_operation_create_folder ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @self:
 139 @parent:
 140 @name:
 141 @Returns:
 142
 143
 144 <!-- ##### FUNCTION modest_mail_operation_remove_folder ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @self:
 150 @folder:
 151 @remove_to_trash:
 152
 153
 154 <!-- ##### FUNCTION modest_mail_operation_rename_folder ##### -->
 155 <para>
 156
 157 </para>
 158
 159 @self:
 160 @folder:
 161 @name:
 162
 163
 164 <!-- ##### FUNCTION modest_mail_operation_remove_msg ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @self:
 170 @header:
 171 @remove_to_trash:
 172
 173
 174 <!-- ##### FUNCTION modest_mail_operation_get_task_done ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @self:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION modest_mail_operation_get_task_total ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @self:
 189 @Returns:
 190
 191
 192 <!-- ##### FUNCTION modest_mail_operation_is_finished ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @self:
 198 @Returns:
 199
 200
 201 <!-- ##### FUNCTION modest_mail_operation_get_status ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @self:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION modest_mail_operation_get_error ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @self:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION modest_mail_operation_cancel ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @self:
 225 @Returns:
 226
 227