Work to fix bug NB#80656.
[modest] / src / modest-tny-msg.h
index 14133b5..9d61204 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006, Nokia Corporation
+/* Copyright (c) 2006, 2007, 2008 Nokia Corporation
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -70,6 +70,7 @@ typedef enum _ModestTnyMsgReplyMode {
  * @subject: subject for the messdage
  * @body: body for the message
  * @attachments: a list of attachments (local URIs)
+ * @error: a pointer for errors in message creation
  * 
  * create a new TnyMsg with the given parameters
  * 
@@ -77,7 +78,7 @@ typedef enum _ModestTnyMsgReplyMode {
  */     
 TnyMsg* modest_tny_msg_new (const gchar* mailto, const gchar* mailfrom, const gchar *cc,
                            const gchar *bcc, const gchar* subject, const gchar *body,
-                           GList *attachments);
+                           GList *attachments, GError **err);
 
 /**
  * modest_tny_msg_new_html_plain:
@@ -88,7 +89,9 @@ TnyMsg* modest_tny_msg_new (const gchar* mailto, const gchar* mailfrom, const gc
  * @subject: subject for the message
  * @html_body: body for the message in HTML
  * @plain_body: body for the message in plain text
- * @attachments: a list of attachments (local URIs)
+ * @attachments: a list of attachments (mime parts)
+ * @attachments: a list of images (mime parts)
+ * @error: a pointer for errors in message creation
  * 
  * create a new TnyMsg with the given parameters
  * 
@@ -97,7 +100,7 @@ TnyMsg* modest_tny_msg_new (const gchar* mailto, const gchar* mailfrom, const gc
 TnyMsg* modest_tny_msg_new_html_plain (const gchar* mailto, const gchar* mailfrom, const gchar *cc,
                                       const gchar *bcc, const gchar* subject, 
                                       const gchar *html_body, const gchar *plain_body,
-                                      GList *attachments);
+                                      GList *attachments, GList *images, GError **err);
 
 /**
  * modest_tny_msg_find_body_part:
@@ -114,7 +117,7 @@ TnyMimePart*  modest_tny_msg_find_body_part  (TnyMsg * self, gboolean want_html)
 
 /**
  * modest_tny_msg_find_body:
- * @self: 
+ * @self: some #TnyMsg
  * @want_html: 
  * @is_html: if the original body was html or plain text
  * 
@@ -127,6 +130,8 @@ TnyMimePart*  modest_tny_msg_find_body_part  (TnyMsg * self, gboolean want_html)
 gchar*        modest_tny_msg_get_body        (TnyMsg *self, gboolean want_html, gboolean *is_html);
 
 
+
+
 /**
  * modest_tny_msg_create_forward_msg:
  * @msg: a valid #TnyMsg instance
@@ -145,7 +150,8 @@ TnyMsg*       modest_tny_msg_create_forward_msg   (TnyMsg *msg,
 
 /**
  * modest_tny_msg_create_reply_msg:
- * @msg: a valid #TnyMsg instance
+ * @msg: a valid #TnyMsg instance, or %NULL
+ * @header: a valid #TnyHeader instance, or %NULL
  * @from: the sender of the forwarded mail
  * @signature: signature to add to the reply message
  * @reply_type: the type of formatting used to create the reply message
@@ -155,11 +161,38 @@ TnyMsg*       modest_tny_msg_create_forward_msg   (TnyMsg *msg,
  * 
  * Returns: Returns: a new #TnyMsg, or NULL in case of error
  **/
-TnyMsg*       modest_tny_msg_create_reply_msg     (TnyMsg *msg, 
+TnyMsg*       modest_tny_msg_create_reply_msg     (TnyMsg *msg,
+                                                  TnyHeader *header,
                                                   const gchar *from,
                                                   const gchar *signature,
                                                   ModestTnyMsgReplyType reply_type,
                                                   ModestTnyMsgReplyMode reply_mode);
 
 
+/**
+ * modest_tny_msg_get_parent_unique_id
+ * @msg: a valid #TnyMsg instance, or %NULL
+ * 
+ * gets the unique ID of the 'parent' (the original msg replied to or forward)
+ * 
+ * Returns: Returns: a the parent uid, or NULL if there is none.
+ **/
+const gchar*  modest_tny_msg_get_parent_uid (TnyMsg *msg);
+
+
+/**
+ * modest_tny_msg_estimate_size:
+ * @plain_body: a string
+ * @html_body: a string
+ * @parts_number: a gint (number of additional parts)
+ * @parts_size: a guint64 (sum of size of the additional parts)
+ *
+ * Estimates the size of the resulting message obtained from the size of the body
+ * parts, and adding the estimation of size headers.
+ */
+guint64
+modest_tny_msg_estimate_size (const gchar *plain_body, const gchar *html_body,
+                             guint64 parts_count,
+                             guint64 parts_size);
+
 #endif /* __MODEST_TNY_MSG_H__ */